@dialpad/dialtone-vue 1.0.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -16
- package/dist/dialtone-vue.common.js +82 -72
- package/dist/dialtone-vue.umd.js +82 -72
- package/dist/dialtone-vue.umd.min.js +1 -1
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -2,19 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
Dialtone Vue is a library of Vue components for [Dialtone][dt]. The goal is to simplify and standardize the use of common UI patterns and behaviour across all Dialpad projects.
|
|
4
4
|
|
|
5
|
-
**[Component Documentation Site ↗️][
|
|
5
|
+
**[Component Documentation Site ↗️][dialtone-vue]**
|
|
6
6
|
|
|
7
7
|
[dt]: https://dialpad.design
|
|
8
8
|
|
|
9
9
|
### Project Status
|
|
10
10
|
|
|
11
|
-
Dialtone Vue is a new project, and as such it is under constant development as we add new components and refine existing ones. Please refer to the [
|
|
11
|
+
Dialtone Vue is a new project, and as such it is under constant development as we add new components and refine existing ones. Please refer to the [jira board][jira] to see the status of Dialtone Vue components and request new components that should be in the Dialtone Vue library.
|
|
12
12
|
|
|
13
|
-
[
|
|
14
|
-
|
|
15
|
-
### Timeline
|
|
16
|
-
|
|
17
|
-
Our goal is to have a stable 1.0 release in Q3 2021. At this point, we will split Dialtone Vue into a separate repository and follow semantic versioning.
|
|
13
|
+
[jira]: https://switchcomm.atlassian.net/secure/RapidBoard.jspa?rapidView=246
|
|
18
14
|
|
|
19
15
|
## Usage
|
|
20
16
|
|
|
@@ -26,13 +22,13 @@ import { DtInput, VALIDATION_MESSAGE_TYPES } from '@dialpad/dialtone-vue';
|
|
|
26
22
|
|
|
27
23
|
## Storybook Component Documentation
|
|
28
24
|
|
|
29
|
-
Dialtone Vue uses [Storybook][storybook] for documentation of components, as well as an environment for local development. Please see the [Storybook Documentation Site][
|
|
25
|
+
Dialtone Vue uses [Storybook][storybook] for documentation of components, as well as an environment for local development. Please see the [Storybook Documentation Site][dialtone-vue] for specific usage information and interactive documentation for each Dialtone Vue component.
|
|
30
26
|
|
|
31
27
|
All components in Dialtone Vue should have stories written for them in Storybook. For more information on how to write stories, see the [documentation][stories].
|
|
32
28
|
|
|
33
29
|
[storybook]: https://storybook.js.org
|
|
34
|
-
[
|
|
35
|
-
[stories]: https://
|
|
30
|
+
[dialtone-vue]: https://vue.dialpad.design
|
|
31
|
+
[stories]: https://vue.dialpad.design/?path=/story/docs-storybook-getting-started--page
|
|
36
32
|
|
|
37
33
|
### Running Storybook Locally
|
|
38
34
|
|
|
@@ -60,10 +56,6 @@ See [CONTRIBUTING](./CONTRIBUTING.md).
|
|
|
60
56
|
|
|
61
57
|
### Project Setup
|
|
62
58
|
|
|
63
|
-
#### NPM_AUTH_TOKEN
|
|
64
|
-
|
|
65
|
-
Ensure that `NPM_AUTH_TOKEN` is set in your path. You will need to set the token to an NPM authentication token which has read level access to the `@dialpad` organization.
|
|
66
|
-
|
|
67
59
|
#### Install Dependencies
|
|
68
60
|
|
|
69
61
|
```bash
|
|
@@ -74,9 +66,9 @@ npm install
|
|
|
74
66
|
|
|
75
67
|
Dialtone components should utilize the global immutable CSS classes provided by Dialtone whenever possible. It is a requirement of any project using Dialtone Vue to include these classes.
|
|
76
68
|
|
|
77
|
-
If needed, you can also write custom CSS using
|
|
69
|
+
If needed, you can also write custom CSS using Dialtone LESS variables by importing `../css/dialtone.less`.
|
|
78
70
|
|
|
79
|
-
Please **do not** use any scoped CSS in Dialtone Vue components.
|
|
71
|
+
Please **do not** use any scoped CSS or mixins in Dialtone Vue components.
|
|
80
72
|
|
|
81
73
|
### Unit Tests
|
|
82
74
|
|