@equinor/eds-icons - npm Package Compare versions

Comparing version 0.9.1 to 0.10.0

dist/types/src/data.d.ts

@@ -441,2 +441,3 @@ import type { IconData } from './types';
 export declare const electrical: IconData;
+export declare const wind_turbine: IconData;
 export declare const link_off: IconData;
@@ -443,0 +444,0 @@ export declare const link: IconData;

package.json

 {
   "name": "@equinor/eds-icons",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Icons from the Equinor Design System",
@@ -48,3 +48,4 @@ "main": "dist/icons.cjs.js",
     "dev": "rollup -c -w"
-  }
+  },
+  "readme": "# @equinor/eds-icons\n\nThis package is a collection of the `system icons` from the Equinor Design System as javascript objects.\n\n## Installation\n\n```sh\nnpm install @equinor/eds-icons \n```\nIf you use Typescript, make sure you have typescript >= 3.8 as a devDependency:\n```sh\nnpm install typescript --save-dev\n```\n\n## Usage\n\nImport svg data:\n\n```javascript\nimport { save } from \"@equinor/eds-icons\"\n```\n\n### React\n\nWe have developed a react component to simplify use of the EDS icons library within react.\n\n```javascript\nimport { Icon } from '@equinor/eds-core-react'\nimport { save } from '@equinor/eds-icons'\n\n// Use library approach \nIcon.add({ save }) // (this needs only be done once)\n<Icon name=\"save\" />\n\n// OR \n\n// Use directly via data prop:\n<Icon data={save} />\n\n```\n\n### FAQ\n\n* If you are using NodeJS 13+ for module loading, it now has native ES modules support. Add `\"type\":\"module\"` to your apps `package.json` to enable this.\n\n* If you get a syntax error trying to import ES module, try importing the CJS module as not all loaders have support for ES modules yet\n\n#### Rendering icons\n\nYou can render it using plain [svg](https://developer.mozilla.org/en-US/docs/Web/SVG) or use our provided [React Icon component](#React) in [@equinor/eds-core-react](https://www.npmjs.com/package/@equinor/eds-core-react)\n\n⚠️ Due to how Figma parses and exports svg icons the following attributes must be added to your `<path></path>` element; `fill-rule=\"evenodd\" clip-rule=\"evenodd\"`\n\nUse [EDS Assets in Figma](https://www.figma.com/file/BQjYMxdSdgRkdhKTDDU7L4KU/Assets?node-id=2%3A3)(Equinor Figma account needed🔒) or [storefront](https://eds.equinor.com/assets/system-icons/library/) for icon names. Spaces in icon names are replaced with underscores. \n\n`star-filled -> star_filled`.\n\n### Example of javascript object data\n\n```javascript\n{\n  name: 'star_filled',\n  prefix: 'eds',\n  height: '24',\n  width: '24',\n  svgPathData: 'M12 16.067l4.947 3.6-1.894-5.814L20 10.334h-6.067l-1.933-6-1.933 6H4l4.947 3.52-1.894 5.814 4.947-3.6z',\n}\n```\n\n## Credits\n\nThe EDS system icons are built on a copy of the [Outlined Material Design](https://material.io/resources/icons/?style=outline) icons provided open-source by Google. The icons have been customised and renamed for Equinor’s use.\n"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

616124

increased by0.64%

Lines of code

11296

increased by0.18%

No dependency changes