@dialpad/dialtone-vue 3.1.3 → 3.4.0

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 CHANGED
@@ -40,23 +40,27 @@ Projects using Dialtone Vue should be aware of the requirements:
40
40
 
41
41
  These requirements are enforced via peerdependencies of Dialtone Vue when possible.
42
42
 
43
- <!-- ## Emojis
43
+ ## Emojis
44
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:
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 functions for small and large emojis during initialization of your app:
46
46
 
47
47
  ```js
48
- import { setEmojiAssetUrl } from 'dialtone-vue'
48
+ import { setEmojiAssetUrlSmall, setEmojiAssetUrlLarge } from 'dialtone-vue'
49
49
 
50
- setEmojiAssetUrl('https://my.example.website.com/joypixels/svg/unicode/')
50
+ // 16px and smaller
51
+ setEmojiAssetUrlSmall('https://my.example.website.com/joypixels/svg/unicode/32/', '.png')
52
+ // larger than 16px
53
+ setEmojiAssetUrlLarge('https://my.example.website.com/joypixels/svg/unicode/', '.svg')
51
54
  ```
52
55
 
53
- You may access the emoji.json data for all emojis Dialtone Vue supports via the following module
56
+ You may access the emoji.json data for all emojis Dialtone Vue supports via executing the following function
54
57
 
55
58
  ```js
56
- import { EmojiJson } from 'dialtone-vue'
59
+ import { getEmojiJson } from 'dialtone-vue'
60
+ const emojiData = await getEmojiJson();
57
61
  ```
58
62
 
59
- -->
63
+
60
64
 
61
65
  ## Contributing
62
66