@shopify/polaris-icons - npm Package Compare versions

Comparing version 3.3.0 to 3.4.0

CHANGELOG.md

@@ -5,4 +5,10 @@ # Changelog
 
-<!-- ## Unreleased -->
+## Unreleased
 
+## 3.4.0 - 2019-05-20
+
+### Enhancements
+
+- Added plain SVG files in the `/images` folder for consumers that can't consume React components
+
 ## 3.3.0 - 2019-03-28
@@ -9,0 +15,0 @@

index.d.ts

@@ -162,3 +162,5 @@ export declare const AbandonedCartMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const ColorsMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const ColorMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const ColorsMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const ColorMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const ColumnWithTextMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
@@ -494,2 +496,3 @@ export declare const ColumnWithTextMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const SelectMinor: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const ArrowUpDownMinor: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const SendMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
@@ -507,3 +510,5 @@ export declare const SendMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const SidebarLeftMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const SidebarMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const SidebarLeftMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const SidebarMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const SidebarRightMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
@@ -624,5 +629,2 @@ export declare const SidebarRightMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
 export declare const WifiMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
-export declare const WifiMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;
-export declare const ArrowUpDownMinor: React.SFC<React.SVGProps<SVGSVGElement>>;
-export declare const ColorMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
-export declare const SidebarMajorMonotone: React.SFC<React.SVGProps<SVGSVGElement>>;
+export declare const WifiMajorTwotone: React.SFC<React.SVGProps<SVGSVGElement>>;

package.json

 {
   "name": "@shopify/polaris-icons",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -10,5 +10,6 @@ "author": "Shopify Inc.",
   "scripts": {
+    "prebuild": "yarn run clean",
     "build": "yarn run rollup -c",
     "prepublish": "yarn run build",
-    "clean": "rimraf build types index.js index.es.js"
+    "clean": "rimraf build types index.js index.es.js images"
   },
@@ -22,3 +23,4 @@ "publishConfig": {
     "index.es.js",
-    "index.d.ts"
+    "index.d.ts",
+    "images/*"
   ],
@@ -35,5 +37,5 @@ "repository": {
   "devDependencies": {
-    "@shopify/polaris-icons-raw": "^1.7.0",
+    "@shopify/polaris-icons-raw": "^1.7.1",
     "rollup": "^1.3.2"
   }
 }

README.md

@@ -1,20 +0,56 @@
-# `@shopify/polaris-icons`
+# @shopify/polaris-icons
 
-This is a public package. Although it is possible to use it directly, we recommend using it through [Polaris React](https://github.com/Shopify/polaris-react). All of the icons in this package are also available in Polaris through the [Icon](https://polaris.shopify.com/components/images-and-icons/icon) component.
+[![npm version](https://img.shields.io/npm/v/@shopify/polaris-icons.svg?style=flat)](https://www.npmjs.com/package/@shopify/polaris-icons)
 
-## Usage
+> This package exports a JavaScript file containing the Polaris icons that can be used by partners building on the Shopify platform.
 
-We suggest using the icons from this package in combination with the `Icon` component from `@shopify/polaris`.
+## Getting started
 
-Make sure your app is using `@shopify/polaris` version [`3.10.0`](https://github.com/Shopify/polaris-react/releases/tag/v3.10.0) or higher.
+Although it's possible to use this package directly, we recommend using the icons in this package through [Polaris React](https://github.com/Shopify/polaris-react) in combination with the `Icon` component from that project. Make sure that your app is using Polaris React version 3.10.0 or higher.
 
-```js
-import {Icon} from '@shopify/polaris';
-import {AddMajorMonotone} from '@shopify/polaris-icons';
+## Installation
 
-<Icon source={AddMajorMonotone} />;
+After you have Polaris React installed, you need to add Polaris icons as a dependency.
+
+Run the following command using [npm](https://www.npmjs.com/):
+
 ```
+npm install @shopify/polaris-icons --save
+```
 
-## Development
+If you prefer [Yarn](https://yarnpkg.com/en/), then use the following command instead:
 
-Make changes to this package to add, remove, or rename public icons.
+```
+yarn add @shopify/polaris-icons
+```
+
+## Usage
+
+Import the `Icon` component from Polaris React and any icon from Polaris icons into your project.
+
+1. Include the icon component from Polaris React:
+
+   ```tsx
+   import {Icon} from '@shopify/polaris';
+   ```
+
+2. Include an icon from Polaris icons:
+
+   ```tsx
+   import {AddMajorMonotone} from '@shopify/polaris-icons';
+   ```
+
+3. Pass the imported Polaris icon to the `source` prop of the `Icon` component:
+
+   ```tsx
+   <Icon source={AddMajorMonotone} />
+   ```
+
+## Contributing 🙌
+
+Make changes to this package to add, remove, or rename publicly available icons. See our [contributing guide](https://github.com/Shopify/polaris-icons/blob/master/CONTRIBUTING.md). 👀
+
+## Licenses 📝
+
+- Source code is under a [custom license](https://github.com/Shopify/polaris-icons/blob/master/LICENSE.md) based on MIT. The license restricts Polaris icons usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.
+- All icons and images are licensed under the [Polaris Design Guidelines License Agreement](https://polaris.shopify.com/legal/license).

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1340855

increased by28.68%

Number of package files

628

increased by10366.67%

Number of low license alerts

0

decreased by-100%

Number of lines in readme file

57

increased by171.43%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

17532

decreased by-6.67%

No dependency changes