@dialpad/dialtone-vue 3.0.1 → 3.1.2

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.
Files changed (6) hide show
  1. package/README.md +33 -6
  2. package/dist/dialtone-vue.common.js +1056 -330
  3. package/dist/dialtone-vue.umd.js +1056 -330
  4. package/dist/dialtone-vue.umd.min.js +1 -1
  5. package/package.json +12 -6
  6. package/CHANGELOG.md +0 -352
package/README.md CHANGED
@@ -2,10 +2,14 @@
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 ↗️][dialtone-vue]**
5
+ Dialtone Vue is available in Vue 2 as well as Vue 3:
6
+
7
+ - **[Component Documentation Site (Vue 2) ↗️][dialtone-vue]**
8
+ - **[Component Documentation Site (Vue 3) ↗️][dialtone-vue3]**
6
9
 
7
10
  [dt]: https://dialpad.design
8
11
  [dialtone-vue]: https://vue.dialpad.design
12
+ [dialtone-vue3]: https://vue.dialpad.design/vue3
9
13
 
10
14
  ## Project Status
11
15
 
@@ -13,6 +17,13 @@ Dialtone Vue is a new project, and as such it is under constant development as w
13
17
 
14
18
  [jira]: https://switchcomm.atlassian.net/secure/RapidBoard.jspa?rapidView=246
15
19
 
20
+ ## Installation
21
+
22
+ You can install the Dialtone Vue library into your project via the following commands:
23
+
24
+ - Vue 2: `npm install @dialpad/dialtone-vue`
25
+ - Vue 3: `npm install @dialpad/dialtone-vue@vue3`
26
+
16
27
  ## Usage
17
28
 
18
29
  Dialtone Vue components can be imported directly from the package. Some components also export named constants, which can be imported as well:
@@ -26,18 +37,34 @@ Projects using Dialtone Vue should be aware of the requirements:
26
37
  - Dialtone classes must be made available globally (to avoid duplication, Dialtone Vue does not do this for you).
27
38
  - A tool like Webpack must be used to package the SFC components from Dialtone Vue.
28
39
  - LESS preprocessor support for Vue SFC `<style>` blocks.
29
- - Dialtone Vue components are built for Vue 2, with Vue 3 support coming soon.
30
40
 
31
41
  These requirements are enforced via peerdependencies of Dialtone Vue when possible.
32
42
 
43
+ <!-- ## Emojis
44
+
45
+ Dialtone Vue uses [JoyPixels][https://www.joypixels.com/] to render emojis. If you are using the emoji components, Dialtone Vue will use the free joypixels assets hosted on jsdelivr CDN by default. You may wish to use self hosted joypixels assets such as the SVGs only available to premium license holders. In order to do this set your custom asset URL with the following function during initialization of your app:
46
+
47
+ ```js
48
+ import { setEmojiAssetUrl } from 'dialtone-vue'
49
+
50
+ setEmojiAssetUrl('https://my.example.website.com/joypixels/svg/unicode/')
51
+ ```
52
+
53
+ You may access the emoji.json data for all emojis Dialtone Vue supports via the following module
54
+
55
+ ```js
56
+ import { EmojiJson } from 'dialtone-vue'
57
+ ```
58
+
59
+ -->
60
+
33
61
  ## Contributing
34
62
 
35
63
  If you would like to contribute to Dialtone Vue the first step is to get the project running locally. Follow the below quickstart to do so.
36
64
 
37
65
  1. Clone the repo `git clone https://github.com/dialpad/dialtone-vue.git`
38
- 2. Install storybook dependencies `npm run storybook:install`
39
- 3. Install dialtone-vue dependencies `npm install`
40
- 4. Run local dev server `npm start`
41
- 5. Visit local dev server at http://localhost:9011/
66
+ 2. Install dependencies `npm run install:all`
67
+ 3. Run local dev server `npm start`
68
+ 4. Visit local dev server at http://localhost:9011/
42
69
 
43
70
  Next read the more detailed contributor documentation in [CONTRIBUTING.md](.github/CONTRIBUTING.md).