@os-design/omit-emotion-props 1.0.17 → 1.0.19

package/dist/cjs/index.js

@@ -14,6 +14,5 @@ var omitEmotionProps = function omitEmotionProps() {
     }
   };
 };
-var _default = omitEmotionProps;
-exports["default"] = _default;
+var _default = exports["default"] = omitEmotionProps;
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["omitEmotionProps","_len","arguments","length","props","Array","_key","shouldForwardProp","p","includes","_default","exports"],"sources":["../../src/index.ts"],"sourcesContent":["interface OmitEmotionPropsRes {\n  shouldForwardProp: (prop: string) => boolean;\n}\n\nconst omitEmotionProps = (...props: string[]): OmitEmotionPropsRes => ({\n  shouldForwardProp: (p) => !props.includes(p),\n});\n\nexport default omitEmotionProps;\n"],"mappings":";;;;;;AAIA,IAAMA,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAA;EAAA,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAAOC,KAAK,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;IAALF,KAAK,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;EAAA;EAAA,OAAqC;IACrEC,iBAAiB,EAAE,SAAAA,kBAACC,CAAC;MAAA,OAAK,CAACJ,KAAK,CAACK,QAAQ,CAACD,CAAC,CAAC;IAAA;EAC9C,CAAC;AAAA,CAAC;AAAC,IAAAE,QAAA,GAEYV,gBAAgB;AAAAW,OAAA,cAAAD,QAAA"}
+{"version":3,"file":"index.js","names":["omitEmotionProps","_len","arguments","length","props","Array","_key","shouldForwardProp","p","includes","_default","exports"],"sources":["../../src/index.ts"],"sourcesContent":["interface OmitEmotionPropsRes {\n  shouldForwardProp: (prop: string) => boolean;\n}\n\nconst omitEmotionProps = (...props: string[]): OmitEmotionPropsRes => ({\n  shouldForwardProp: (p) => !props.includes(p),\n});\n\nexport default omitEmotionProps;\n"],"mappings":";;;;;;AAIA,IAAMA,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAA;EAAA,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAAOC,KAAK,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;IAALF,KAAK,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;EAAA;EAAA,OAAqC;IACrEC,iBAAiB,EAAE,SAAAA,kBAACC,CAAC;MAAA,OAAK,CAACJ,KAAK,CAACK,QAAQ,CAACD,CAAC,CAAC;IAAA;EAC9C,CAAC;AAAA,CAAC;AAAC,IAAAE,QAAA,GAAAC,OAAA,cAEYX,gBAAgB","ignoreList":[]}

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["omitEmotionProps","props","shouldForwardProp","p","includes"],"sources":["../../src/index.ts"],"sourcesContent":["interface OmitEmotionPropsRes {\n  shouldForwardProp: (prop: string) => boolean;\n}\n\nconst omitEmotionProps = (...props: string[]): OmitEmotionPropsRes => ({\n  shouldForwardProp: (p) => !props.includes(p),\n});\n\nexport default omitEmotionProps;\n"],"mappings":"AAIA,MAAMA,gBAAgB,GAAGA,CAAC,GAAGC,KAAe,MAA2B;EACrEC,iBAAiB,EAAGC,CAAC,IAAK,CAACF,KAAK,CAACG,QAAQ,CAACD,CAAC;AAC7C,CAAC,CAAC;AAEF,eAAeH,gBAAgB"}
+{"version":3,"file":"index.js","names":["omitEmotionProps","props","shouldForwardProp","p","includes"],"sources":["../../src/index.ts"],"sourcesContent":["interface OmitEmotionPropsRes {\n  shouldForwardProp: (prop: string) => boolean;\n}\n\nconst omitEmotionProps = (...props: string[]): OmitEmotionPropsRes => ({\n  shouldForwardProp: (p) => !props.includes(p),\n});\n\nexport default omitEmotionProps;\n"],"mappings":"AAIA,MAAMA,gBAAgB,GAAGA,CAAC,GAAGC,KAAe,MAA2B;EACrEC,iBAAiB,EAAGC,CAAC,IAAK,CAACF,KAAK,CAACG,QAAQ,CAACD,CAAC;AAC7C,CAAC,CAAC;AAEF,eAAeH,gBAAgB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@os-design/omit-emotion-props",
-  "version": "1.0.17",
+  "version": "1.0.19",
   "license": "UNLICENSED",
   "repository": "git@gitlab.com:os-team/libs/os-design.git",
   "main": "dist/cjs/index.js",
@@ -24,7 +24,7 @@
     "build:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/esm --source-maps",
     "build:cjs": "cross-env BABEL_ENV=cjs babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/cjs --source-maps",
     "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
-    "build": "yarn clean && npm-run-all build:*",
+    "build": "yarn clean && npm-run-all 'build:*'",
     "ncu": "ncu -u"
   },
   "publishConfig": {
@@ -33,5 +33,5 @@
   "devDependencies": {
     "react": ">=18"
   },
-  "gitHead": "f838bd8885cdaf45e62a3b61fa2f83f2d2036e09"
+  "gitHead": "1f17189e344a56fd6347dd6b896d6e7ef6e7b35d"
 }

package/src/index.mdx

@@ -0,0 +1,47 @@
+import { Meta } from '@storybook/blocks';
+import { Square, SquareWithoutProps } from './index.example';
+
+<Meta title='Utils/omitEmotionProps' />
+
+# omitEmotionProps
+
+Disables forwarding the specified properties to the element.
+See more in the [emotion docs](https://emotion.sh/docs/styled#customizing-prop-forwarding).
+
+## Example of usage
+
+Pass `omitEmotionProps('prop1', 'prop2')` as a second argument of the `styled` function.
+You can specify as many properties as you want.
+
+```tsx
+import styled from '@emotion/styled';
+import { omitEmotionProps } from '@os-design/styles';
+
+interface SquareProps {
+  size: number;
+  color: string;
+}
+
+export const Square = styled.div<SquareProps>`
+  width: ${(p) => p.size}em;
+  height: ${(p) => p.size}em;
+  background-color: ${(p) => p.color};
+`;
+
+export const SquareWithoutProps = styled(
+  'div',
+  omitEmotionProps('size', 'color')
+)<SquareProps>`
+  width: ${(p) => p.size}em;
+  height: ${(p) => p.size}em;
+  background-color: ${(p) => p.color};
+`;
+```
+
+As a result, the `size` and `color` properties will not be passed to the HTML element (see the HTML code).
+
+<SquareWithoutProps size={10} color='gray' />
+
+If you did not use the `omitEmotionProps` function, the properties will be passed to the HTML element (see the HTML code).
+
+<Square size={10} color='gray' />