Dialtone Vue is a library of Vue components for Dialtone. The goal is to simplify and standardize the use of common UI patterns and behaviour across all Dialpad projects.

• Component Documentation Site ↗️

You can install the Dialtone Vue library into your project via the following command:

npm install @dialpad/dialtone-css @dialpad/dialtone-vue

Note: Dialtone Vue 2 has been deprecated. Please use Dialtone Vue 3.

First you must globally import Dialtone's css:

import '@dialpad/dialtone-css';

or

@import '@dialpad/dialtone-css';

Dialtone Vue components can be imported directly from the package. Some components also export named constants, which can be imported as well:

import { DtInput, VALIDATION_MESSAGE_TYPES } from '@dialpad/dialtone-vue';

Projects using Dialtone Vue should be aware of the requirements:

• Dialtone classes must be made available globally (to avoid duplication, Dialtone Vue does not do this for you).
• A tool like Webpack must be used to package the SFC components from Dialtone Vue.
• LESS preprocessor support for Vue SFC <style> blocks.

These requirements are enforced via peer dependencies of Dialtone Vue when possible.

Dialtone Vue uses JoyPixels 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:

import { setEmojiAssetUrlSmall, setEmojiAssetUrlLarge } from '@dialpad/dialtone-vue'

// 16px and smaller
setEmojiAssetUrlSmall('https://my.example.website.com/joypixels/svg/unicode/32/', '.png')
// larger than 16px
setEmojiAssetUrlLarge('https://my.example.website.com/joypixels/svg/unicode/', '.svg')

You may access the emoji.json data for all emojis Dialtone Vue supports via executing the following function

import { getEmojiData } from '@dialpad/dialtone-vue'
const emojiData = getEmojiData();

Dialtone Vue has localization capabilities built-in. It is implemented using goblin-client-tools/i18n We use SmartLing for our translation process.

All the localization related files are located at localization folder.

Important folder contents:

• index.js: Contains the main logic of the Localization.
• sync-icons.js: Syncs the icons list to the en-US.ftl localization strings (currently unused due to large number of icons).
• en-US.ftl: List of strings to translate, written with FTL syntax.
• *.ftl: The rest of the FTL files are the translations for the strings in en-US.ftl, they got updated once the translation is ready in Smartling.

The translation process is as follows:

1. Add the new string(s) to en-US.ftl.
2. If the component doesn't already use i18n, create an instance with i18n = new DialtoneLocalization()
3. Use the string to get the translation like so i18n.$t('STRING_NAME')
4. Create a PR with your changes.
5. Once merged to staging, the new strings are sent to Smartling for translation using push translations workflow
6. A translation request job is run daily on Smartling.
7. pull translations workflow runs on a daily basis.
8. Once it detects translations that are ready, it creates a PR containing the translations.

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.

1. Clone the monorepo git clone git@github.com:dialpad/dialtone.git
2. Install dependencies pnpm install
3. Run local dev server nx run dialtone-vue:start
4. Visit local dev server at http://localhost:9011/

Next read the more detailed contributor documentation in CONTRIBUTING.md.

Please refer to the jira board to see what we are currently working on and what we have planned for the future.

Requesting a feature or reporting a bug? Please do so at the below links:

• Request Feature
• Report Bug

Please also feel free to contact us via the #dialtone Dialpad channel with any questions