@os-design/omit-emotion-props 1.0.18 → 1.0.20

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;CAC9C;AAED,QAAA,MAAM,gBAAgB,aAAc,MAAM,EAAE,KAAG,mBAE7C,CAAC;AAEH,eAAe,gBAAgB,CAAC"}

package/dist/{esm/index.js → index.js}

@@ -1,5 +1,4 @@
 const omitEmotionProps = (...props) => ({
   shouldForwardProp: p => !props.includes(p)
 });
-export default omitEmotionProps;
-//# sourceMappingURL=index.js.map
+export default omitEmotionProps;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@os-design/omit-emotion-props",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "license": "UNLICENSED",
   "repository": "git@gitlab.com:os-team/libs/os-design.git",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "react-native": "src/index.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "react-native": "./src/index.ts",
   "files": [
     "dist",
     "src",
@@ -21,9 +21,8 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf dist",
-    "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:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist",
+    "build:types": "tsc -p tsconfig.build.json --emitDeclarationOnly --declaration --declarationDir dist",
     "build": "yarn clean && npm-run-all 'build:*'",
     "ncu": "ncu -u"
   },
@@ -33,5 +32,5 @@
   "devDependencies": {
     "react": ">=18"
   },
-  "gitHead": "2605fbf8f46c78800cd4ba6dcb0dd895a893bf96"
+  "gitHead": "86a83e87297a07afe132782ca2c95023b7139276"
 }

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' />

package/dist/cjs/index.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var omitEmotionProps = function omitEmotionProps() {
-  for (var _len = arguments.length, props = new Array(_len), _key = 0; _key < _len; _key++) {
-    props[_key] = arguments[_key];
-  }
-  return {
-    shouldForwardProp: function shouldForwardProp(p) {
-      return !props.includes(p);
-    }
-  };
-};
-var _default = omitEmotionProps;
-exports["default"] = _default;
-//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +0,0 @@
-{"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"}

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"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"}

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;CAC9C;AAED,QAAA,MAAM,gBAAgB,aAAc,MAAM,EAAE,KAAG,mBAE7C,CAAC;AAEH,eAAe,gBAAgB,CAAC"}