Deprecate use of sx prop by deprecating the SxProp type definition (#…

…5443) * Use DeprecatedSxProp instead of SxProp * Create few-coins-kick.md * Fix typo in changeset description * Use SxProp and deprecate that instead * Fix typo in changeset description * Fix typo in changeset description
primer · Dec 18, 2024 · f03ae58 · f03ae58
1 parent b07f806
commit f03ae58
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.changeset/few-coins-kick.md b/.changeset/few-coins-kick.md
@@ -0,0 +1,5 @@
+---
+"@primer/react": minor
+---
+
+Deprecate use of sx prop by deprecating the `SxProp` type definition
diff --git a/packages/react/src/sx.ts b/packages/react/src/sx.ts
@@ -26,6 +26,7 @@ type CSSSelectorObject = {
 export type BetterSystemStyleObject = BetterCssProperties | SystemStyleObject | CSSCustomProperties | CSSSelectorObject
 
 export interface SxProp {
+  /** @deprecated Use CSS modules for styling instead */
   sx?: BetterSystemStyleObject
 }