Skip to content

Commit 1dd4ffc

Browse files
committed
feat: update docs and fix breadcrumb
1 parent c42aee3 commit 1dd4ffc

File tree

7 files changed

+22
-27
lines changed

7 files changed

+22
-27
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,18 @@ yarn add @hyone/hyone-ui
1414

1515
### Use
1616

17-
After installing, to use HyONE Vue, you will need to import the desired components to use them.
17+
After installing, add HyONEPlugin to your vue instance.
1818

19-
- In Vue script:
19+
- In main js:
2020
```js
21-
import { AButton } from '@hyone/hyone-ui';
22-
export default {
23-
components: { AButton }
24-
};
21+
import { createApp } from 'vue';
22+
import '@hyone/hyone-ui/dist/hyone-ui.css';
23+
import { HyONEPlugin } from '@hyone/hyone-ui';
24+
import App from './app.vue'
25+
26+
createApp
27+
.use(HyONEPlugin)
28+
.mount('#root');
2529
```
2630

2731
- In template:

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
"*.js"
2828
],
2929
"dependencies": {
30-
"click-outside-vue3": "^4.0.1",
3130
"core-js": "^3.6.5",
3231
"url-join": "^4.0.1",
3332
"vue": "^3.0.0",

src/components/molecules/a-breadcrumb/a-breadcrumb.vue

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@
88
class="a-breadcrumb__item"
99
:size="(index === 0) ? 'small' : 'extra-small'"
1010
tag="a"
11-
:weight="(index === 0) ? 'extra-bold' : 'bold'"
11+
:weight="(index === 0) ? 'bold' : 'medium'"
1212
>
13-
<template>
14-
{{ item.text }}
15-
</template>
13+
{{ item.text }}
1614
</ATitle>
1715
</nav>
1816
</template>
File renamed without changes.

src/components/molecules/a-dropdown/a-dropdown.vue

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<template>
22
<div
3-
v-click-outside="handleClickOutside"
43
class="a-dropdown"
54
>
65
<AButton
@@ -41,17 +40,13 @@
4140
</template>
4241

4342
<script>
44-
import vClickOutside from 'click-outside-vue3';
4543
import { shouldBeOneOf } from 'vue-prop-validation-helper';
4644
import { AButton } from '@/components/atoms/a-button';
4745
4846
export default {
4947
components: {
5048
AButton,
5149
},
52-
directives: {
53-
vClickOutside: vClickOutside.directive,
54-
},
5550
props: {
5651
position: {
5752
type: String,

src/docs/0.welcome-aurora-vue.stories.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,18 @@ yarn add @hyone/hyone-ui
1919

2020
### Use
2121

22-
After installing, to use Aurora Vue, you will need to import the desired components to use them.
22+
After installing, add HyONEPlugin to your vue instance.
2323

24-
- In Vue script:
24+
- In main js:
2525
```js
26-
import { AButton } from '@hyone/hyone-ui';
27-
export default {
28-
components: { AButton }
29-
};
26+
import { createApp } from 'vue';
27+
import '@hyone/hyone-ui/dist/hyone-ui.css';
28+
import { HyONEPlugin } from '@hyone/hyone-ui';
29+
import App from './app.vue'
30+
31+
createApp
32+
.use(HyONEPlugin)
33+
.mount('#root');
3034
```
3135

3236
- In template:

yarn.lock

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5272,11 +5272,6 @@ cli-width@^3.0.0:
52725272
resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-3.0.0.tgz#a2f48437a2caa9a22436e794bf071ec9e61cedf6"
52735273
integrity sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==
52745274

5275-
click-outside-vue3@^4.0.1:
5276-
version "4.0.1"
5277-
resolved "https://registry.yarnpkg.com/click-outside-vue3/-/click-outside-vue3-4.0.1.tgz#81a6ac01696b301764b42db6fdbdf28e7cd8ef95"
5278-
integrity sha512-sbplNecrup5oGqA3o4bo8XmvHRT6q9fvw21Z67aDbTqB9M6LF7CuYLTlLvNtOgKU6W3zst5H5zJuEh4auqA34g==
5279-
52805275
clipboardy@^2.3.0:
52815276
version "2.3.0"
52825277
resolved "https://registry.yarnpkg.com/clipboardy/-/clipboardy-2.3.0.tgz#3c2903650c68e46a91b388985bc2774287dba290"

0 commit comments

Comments
 (0)