Skip to content

Commit a241567

Browse files
committed
Minor: remove unneccessary lines & restructure docs
1 parent c9316d3 commit a241567

File tree

10 files changed

+53
-41
lines changed

10 files changed

+53
-41
lines changed

.storybook/main.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
},
2020
'@storybook/addon-links',
2121
'@storybook/addon-essentials',
22-
'@storybook/addon-knobs',
22+
// '@storybook/addon-knobs',
2323
],
2424
webpackFinal: async (config, { configType }) => {
2525
config.module.rules.push(
@@ -35,6 +35,7 @@ module.exports = {
3535
'postcss-loader',
3636
'sass-loader',
3737
],
38+
include: path.resolve(__dirname, '../src/components'),
3839
},
3940
);
4041

.storybook/preview.js

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ export const decorators = [(story) => ({
1313

1414
export const parameters = {
1515
viewMode: 'docs',
16-
actions: { disable: true },
1716
controls: {
1817
matchers: {
1918
color: /(background|color|backgroundColor)$/i,
@@ -26,17 +25,9 @@ export const parameters = {
2625
storySort: {
2726
order: [
2827
"Get Started",
28+
"Polaris Icons",
2929
"Changelog",
30-
"Actions",
31-
"Structure",
32-
"Forms",
33-
"Images & Icons",
34-
"Feedback indicators",
35-
"Titles & Text",
36-
"Behavior",
37-
"Lists & Tables",
38-
"Navigation",
39-
"Overlays",
30+
"Components",
4031
]
4132
}
4233
},

.storybook/stories/GetStarted.stories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Use as a Vue plugin (globally registers all components):
4444

4545
```js
4646
import Vue from 'vue';
47-
import PolarisVue from 'polaris-vue';
47+
import PolarisVue from '@qikify/polaris-vue';
4848
import '@qikify/polaris-vue/dist/polaris-vue.css';
4949

5050
Vue.use(PolarisVue);
@@ -60,7 +60,7 @@ OR use individual component:
6060

6161
```js
6262
import Vue from 'vue';
63-
import { List, Icon } from 'polaris-vue';
63+
import { List, Icon } from '@qikify/polaris-vue';
6464

6565
new Vue({
6666
components: {
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import { Meta } from '@storybook/addon-docs';
2+
3+
<Meta
4+
title="Polaris Icons"
5+
parameters={{
6+
viewMode: 'docs',
7+
isToolshown: false,
8+
previewTabs: {
9+
'canvas': {
10+
hidden: true,
11+
},
12+
},
13+
}}
14+
/>
15+
16+
Coming soon...

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Use as a Vue plugin (globally registers all components):
3030

3131
```js
3232
import Vue from 'vue';
33-
import PolarisVue from 'polaris-vue';
33+
import PolarisVue from '@qikify/polaris-vue';
3434
import '@qikify/polaris-vue/dist/polaris-vue.css';
3535

3636
Vue.use(PolarisVue);
@@ -46,7 +46,7 @@ new Vue({
4646

4747
```js
4848
import Vue from 'vue';
49-
import { List, Icon } from 'polaris-vue';
49+
import { List, Icon } from '@qikify/polaris-vue';
5050

5151
new Vue({
5252
components: {

build/rollup.config.base.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export default {
1616
}),
1717
alias({
1818
entries: [
19-
{ find: /@/, replacement: `${path.resolve(__dirname, '../src')}` },
19+
{ find: /@\//, replacement: `${path.resolve(__dirname, '../src/')}` },
2020
],
2121
}),
2222
postcss(),

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "polaris-vue",
2+
"name": "@qikify/polaris-vue",
33
"version": "0.1.0",
44
"description": "Shopify Polaris UI library for Vue 2",
55
"author": {
@@ -40,13 +40,12 @@
4040
"@rollup/plugin-json": "^4.1.0",
4141
"@rollup/plugin-node-resolve": "^13.0.6",
4242
"@rollup/plugin-replace": "^3.0.0",
43+
"@shopify/polaris-icons": "^4.11.0",
4344
"@storybook/addon-docs": "^6.4.8",
4445
"@storybook/addon-essentials": "^6.4.8",
4546
"@storybook/addon-knobs": "^6.4.0",
4647
"@storybook/addon-links": "^6.3.12",
47-
"@storybook/addon-postcss": "^2.0.0",
4848
"@storybook/addons": "^6.4.8",
49-
"@storybook/preset-scss": "^1.0.3",
5049
"@storybook/preset-typescript": "^3.0.0",
5150
"@storybook/theming": "^6.4.8",
5251
"@storybook/vue": "^6.4.8",
@@ -82,6 +81,7 @@
8281
"sass-loader": "^10",
8382
"shx": "^0.3.3",
8483
"style-loader": "^2",
84+
"ts-dedent": "^2.2.0",
8585
"ttypescript": "^1.5.13",
8686
"typescript": "~4.1.5",
8787
"typescript-plugin-css-modules": "^3.4.0",

src/components/Icon/Icon.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ span(:class="wrapperClassName")
2323
import Vue, { VueConstructor } from 'vue';
2424
import { Component, Prop } from 'vue-property-decorator';
2525
import { classNames, variationName } from 'polaris-react/src/utilities/css';
26-
import type { IconSource } from '@/type';
26+
import type { IconSource } from 'types/type';
2727
import styles from '@/classes/Icon.json';
2828
import { VisuallyHidden } from '../VisuallyHidden';
2929
File renamed without changes.

yarn.lock

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1501,6 +1501,11 @@
15011501
resolved "https://registry.yarnpkg.com/@shopify/polaris-icons/-/polaris-icons-4.10.0.tgz#fbfc0628c7da0786a6cbe9069ee007070762a4ac"
15021502
integrity sha512-TxOJeLd4qXNl8bhEtJ3bQrjMgdOTzw3xDfKhqWTinBMcjDsW0+Rb8ynSsxzS9ut821L3qXJK9AnJZwoR/Yd8nw==
15031503

1504+
"@shopify/polaris-icons@^4.11.0":
1505+
version "4.11.0"
1506+
resolved "https://registry.yarnpkg.com/@shopify/polaris-icons/-/polaris-icons-4.11.0.tgz#8b1ebf7f07077300f8281e12824588835f108b23"
1507+
integrity sha512-vq37+I6oDlFzQXqkuDI0DO4AXz36AiyGOMkSstnBWTI6UR/eHAuI2aALqbPMxYbD6877Pi1kk+bAfWIFf3D4LA==
1508+
15041509
"@shopify/polaris-tokens@^3.0.0":
15051510
version "3.1.0"
15061511
resolved "https://registry.yarnpkg.com/@shopify/polaris-tokens/-/polaris-tokens-3.1.0.tgz#1e02974e8640b49678ca88ac0dae1de89ed706d9"
@@ -1730,17 +1735,6 @@
17301735
regenerator-runtime "^0.13.7"
17311736
ts-dedent "^2.0.0"
17321737

1733-
"@storybook/addon-postcss@^2.0.0":
1734-
version "2.0.0"
1735-
resolved "https://registry.yarnpkg.com/@storybook/addon-postcss/-/addon-postcss-2.0.0.tgz#ec61cb9bb2662f408072b35c466c7df801c28498"
1736-
integrity sha512-Nt82A7e9zJH4+A+VzLKKswUfru+T6FJTakj4dccP0i8DSn7a0CkzRPrLuZBq8tg4voV6gD74bcDf3gViCVBGtA==
1737-
dependencies:
1738-
"@storybook/node-logger" "^6.1.14"
1739-
css-loader "^3.6.0"
1740-
postcss "^7.0.35"
1741-
postcss-loader "^4.2.0"
1742-
style-loader "^1.3.0"
1743-
17441738
"@storybook/[email protected]":
17451739
version "6.4.8"
17461740
resolved "https://registry.yarnpkg.com/@storybook/addon-toolbars/-/addon-toolbars-6.4.8.tgz#e34e65aae7dfd6292e57bccf36cdf6a060bbd84e"
@@ -2263,7 +2257,7 @@
22632257
webpack-dev-middleware "^3.7.3"
22642258
webpack-virtual-modules "^0.2.2"
22652259

2266-
"@storybook/[email protected]", "@storybook/node-logger@^6.1.14":
2260+
"@storybook/[email protected]":
22672261
version "6.4.8"
22682262
resolved "https://registry.yarnpkg.com/@storybook/node-logger/-/node-logger-6.4.8.tgz#403a21abf2335d8daf88f2f17ceda2ad6719a691"
22692263
integrity sha512-1gma7KvRXt/wsHzajf1h49r9vfV0TAnv/0OkryvV+sqtK48JV7A6kbVpBK0BtZBRqrQDfYTpCauX4VHfi7yBrQ==
@@ -2293,11 +2287,6 @@
22932287
dependencies:
22942288
core-js "^3.8.2"
22952289

2296-
"@storybook/preset-scss@^1.0.3":
2297-
version "1.0.3"
2298-
resolved "https://registry.yarnpkg.com/@storybook/preset-scss/-/preset-scss-1.0.3.tgz#8ac834545c642dada0f64f510ef08dfb882e9737"
2299-
integrity sha512-o9Iz6wxPeNENrQa2mKlsDKynBfqU2uWaRP80HeWp4TkGgf7/x3DVF2O7yi9N0x/PI1qzzTTpxlQ90D62XmpiTw==
2300-
23012290
"@storybook/preset-typescript@^3.0.0":
23022291
version "3.0.0"
23032292
resolved "https://registry.yarnpkg.com/@storybook/preset-typescript/-/preset-typescript-3.0.0.tgz#e157baf6f2c4982c3da3328f5e1a640b3d7db9e4"
@@ -11559,7 +11548,7 @@ postcss@^6.0.1, postcss@^6.0.14, postcss@^6.0.2:
1155911548
source-map "^0.6.1"
1156011549
supports-color "^5.4.0"
1156111550

11562-
postcss@^7.0.0, postcss@^7.0.1, postcss@^7.0.14, postcss@^7.0.18, postcss@^7.0.26, postcss@^7.0.27, postcss@^7.0.32, postcss@^7.0.35, postcss@^7.0.36, postcss@^7.0.5, postcss@^7.0.6:
11551+
postcss@^7.0.0, postcss@^7.0.1, postcss@^7.0.14, postcss@^7.0.18, postcss@^7.0.26, postcss@^7.0.27, postcss@^7.0.32, postcss@^7.0.36, postcss@^7.0.5, postcss@^7.0.6:
1156311552
version "7.0.39"
1156411553
resolved "https://registry.yarnpkg.com/postcss/-/postcss-7.0.39.tgz#9624375d965630e2e1f2c02a935c82a59cb48309"
1156511554
integrity sha512-yioayjNbHn6z1/Bywyb2Y4s3yvDAeXGOyxqD+LnVOinq6Mdmd++SW2wUNVzavyyHxd6+DxzWGIuosg6P1Rj8uA==
@@ -13721,7 +13710,14 @@ svg-tags@^1.0.0:
1372113710
resolved "https://registry.yarnpkg.com/svg-tags/-/svg-tags-1.0.0.tgz#58f71cee3bd519b59d4b2a843b6c7de64ac04764"
1372213711
integrity sha1-WPcc7jvVGbWdSyqEO2x95krAR2Q=
1372313712

13724-
svgo@^1.0.0:
13713+
svg-to-vue@^0.7.0:
13714+
version "0.7.0"
13715+
resolved "https://registry.yarnpkg.com/svg-to-vue/-/svg-to-vue-0.7.0.tgz#ec86deb1742be38319462e36703af1dfa2f9fad9"
13716+
integrity sha512-Tg2nMmf3BQorYCAjxbtTkYyWPVSeox5AZUFvfy4MoWK/5tuQlnA/h3LAlTjV3sEvOC5FtUNovRSj3p784l4KOA==
13717+
dependencies:
13718+
svgo "^1.3.2"
13719+
13720+
svgo@^1.0.0, svgo@^1.3.2:
1372513721
version "1.3.2"
1372613722
resolved "https://registry.yarnpkg.com/svgo/-/svgo-1.3.2.tgz#b6dc511c063346c9e415b81e43401145b96d4167"
1372713723
integrity sha512-yhy/sQYxR5BkC98CY7o31VGsg014AKLEPxdfhora76l36hD9Rdy5NZA/Ocn6yayNPgSamYdtX2rFJdcv07AYVw==
@@ -14055,7 +14051,7 @@ tryer@^1.0.1:
1405514051
resolved "https://registry.yarnpkg.com/tryer/-/tryer-1.0.1.tgz#f2c85406800b9b0f74c9f7465b81eaad241252f8"
1405614052
integrity sha512-c3zayb8/kWWpycWYg87P71E1S1ZL6b6IJxfb5fvsUgsf0S2MVGaDhDXXjDMpdCpfWXqptc+4mXwmiy1ypXqRAA==
1405714053

14058-
ts-dedent@^2.0.0:
14054+
ts-dedent@^2.0.0, ts-dedent@^2.2.0:
1405914055
version "2.2.0"
1406014056
resolved "https://registry.yarnpkg.com/ts-dedent/-/ts-dedent-2.2.0.tgz#39e4bd297cd036292ae2394eb3412be63f563bb5"
1406114057
integrity sha512-q5W7tVM71e2xjHZTlgfTDoPF/SmqKG5hddq9SzR49CH2hayqRKJtQ4mtRlSxKaJlR/+9rEM+mnBHf7I2/BQcpQ==
@@ -14825,6 +14821,14 @@ vue-style-loader@^4.1.0, vue-style-loader@^4.1.2:
1482514821
hash-sum "^1.0.2"
1482614822
loader-utils "^1.0.2"
1482714823

14824+
vue-svg-loader@^0.16.0:
14825+
version "0.16.0"
14826+
resolved "https://registry.yarnpkg.com/vue-svg-loader/-/vue-svg-loader-0.16.0.tgz#adccbdc9aca90132bde9c9d96cd49f74efecd345"
14827+
integrity sha512-2RtFXlTCYWm8YAEO2qAOZ2SuIF2NvLutB5muc3KDYoZq5ZeCHf8ggzSan3ksbbca7CJ/Aw57ZnDF4B7W/AkGtw==
14828+
dependencies:
14829+
loader-utils "^1.2.3"
14830+
svg-to-vue "^0.7.0"
14831+
1482814832
vue-template-compiler@^2.6.11:
1482914833
version "2.6.14"
1483014834
resolved "https://registry.yarnpkg.com/vue-template-compiler/-/vue-template-compiler-2.6.14.tgz#a2f0e7d985670d42c9c9ee0d044fed7690f4f763"

0 commit comments

Comments
 (0)