@dialpad/dialtone 9.34.3 → 9.34.4
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 +145 -29
- package/dist/css/dialtone.css +2 -2
- package/dist/tokens/css/variables-dark.css +1 -1
- package/dist/tokens/css/variables-expressive-dark.css +1 -1
- package/dist/tokens/css/variables-expressive-light.css +1 -1
- package/dist/tokens/css/variables-expressive-sm-dark.css +1 -1
- package/dist/tokens/css/variables-expressive-sm-light.css +1 -1
- package/dist/tokens/css/variables-light.css +1 -1
- package/dist/tokens/css/variables-tmo-dark.css +1 -1
- package/dist/tokens/css/variables-tmo-light.css +1 -1
- package/dist/tokens/less/variables-dark.less +1 -1
- package/dist/tokens/less/variables-expressive-dark.less +1 -1
- package/dist/tokens/less/variables-expressive-light.less +1 -1
- package/dist/tokens/less/variables-expressive-sm-dark.less +1 -1
- package/dist/tokens/less/variables-expressive-sm-light.less +1 -1
- package/dist/tokens/less/variables-light.less +1 -1
- package/dist/tokens/less/variables-tmo-dark.less +1 -1
- package/dist/tokens/less/variables-tmo-light.less +1 -1
- package/package.json +1 -4
package/README.md
CHANGED
|
@@ -323,49 +323,165 @@ nx build dialtone-documentation
|
|
|
323
323
|
|
|
324
324
|
### Releasing
|
|
325
325
|
|
|
326
|
-
|
|
327
|
-
|
|
326
|
+
Currently, Dialtone packages are being release in two different ways: `scheduled` and `manually`.
|
|
327
|
+
The `scheduled` release will only release changes to `production` while `manually` you can choose to release
|
|
328
|
+
`alpha`, `beta` or `next` branches.
|
|
328
329
|
|
|
329
|
-
|
|
330
|
-
[release.yml](https://github.com/dialpad/dialtone/actions/workflows/release.yml)
|
|
330
|
+
#### Production
|
|
331
331
|
|
|
332
|
-
|
|
333
|
-
option on GitHub.
|
|
332
|
+
##### Scheduled
|
|
334
333
|
|
|
335
|
-
|
|
336
|
-
|
|
334
|
+
On every Tuesday at 10:00 am UTC, [release action](.github/workflows/release.yml) will trigger the production release process which
|
|
335
|
+
automatically release all packages that need to be released following the next steps:
|
|
337
336
|
|
|
338
|
-
|
|
337
|
+
1. Run the `nx release` on every project.
|
|
338
|
+
2. Merge the release commits created by the semantic release bot on `staging` to `production` branch.
|
|
339
|
+
3. Push the `production` branch.
|
|
340
|
+
4. An [action](https://github.com/dialpad/dialtone/actions/workflows/publish.yml) will publish the packages with its corresponding tag.
|
|
341
|
+
|
|
342
|
+
##### Manually
|
|
339
343
|
|
|
340
|
-
|
|
344
|
+
In case you need to release earlier than the next scheduled date, you can trigger the release via `Run workflow` on [GitHub](https://github.com/dialpad/dialtone/actions/workflows/release.yml).
|
|
341
345
|
|
|
342
|
-
1.
|
|
343
|
-
2.
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
346
|
+
1. Select `staging` branch.
|
|
347
|
+
2. Select the `package` that you want to release or leave it empty to release all of them.
|
|
348
|
+
|
|
349
|
+
This will trigger the [release action](.github/workflows/release.yml), release changes on `staging` and automatically publish the selected packages following the next steps:
|
|
350
|
+
|
|
351
|
+
1. Run the `nx release` on selected packages (all if `package` is empty).
|
|
352
|
+
2. Merge the release commits created by the semantic release bot on `staging` to `production` branch.
|
|
353
|
+
3. Push the `production` branch.
|
|
354
|
+
4. An [action](https://github.com/dialpad/dialtone/actions/workflows/publish.yml) will publish the packages with its corresponding tag.
|
|
348
355
|
|
|
349
356
|
```bash
|
|
350
357
|
nx run release
|
|
351
358
|
```
|
|
352
359
|
|
|
353
|
-
#### Alpha/Beta
|
|
360
|
+
#### Alpha/Beta/Next
|
|
354
361
|
|
|
355
|
-
|
|
362
|
+
##### Manually
|
|
356
363
|
|
|
357
|
-
1.
|
|
358
|
-
2.
|
|
359
|
-
3.
|
|
360
|
-
4.
|
|
361
|
-
5. Push updated `alpha/beta` branch to origin.
|
|
362
|
-
- A GHA will publish the release on npm and GitHub with `@alpha` or `@beta` tag.
|
|
363
|
-
6. Merge changes from `alpha/beta` back to your feature branch.
|
|
364
|
+
1. Merge your changes to the branch you want to release, commit and push to origin.
|
|
365
|
+
2. Go to [GitHub](https://github.com/dialpad/dialtone/actions/workflows/release.yml) and click on `Run workflow`.
|
|
366
|
+
3. Select `alpha`, `beta` or `next` branch.
|
|
367
|
+
4. Select the `package` that you want to release or leave it empty to release all of them.
|
|
364
368
|
|
|
365
|
-
|
|
366
|
-
|
|
369
|
+
This will trigger the [release action](.github/workflows/release.yml), release changes on the selected branch and automatically publish the selected packages following the next steps:
|
|
370
|
+
|
|
371
|
+
1. Run the `nx release` on selected packages (all if `package` is empty).
|
|
372
|
+
2. An [action](https://github.com/dialpad/dialtone/actions/workflows/publish.yml) will publish the packages with its corresponding tag.
|
|
373
|
+
|
|
374
|
+
## Usage
|
|
375
|
+
|
|
376
|
+
### Install it via NPM:
|
|
377
|
+
|
|
378
|
+
#### Vue 3
|
|
379
|
+
|
|
380
|
+
```shell
|
|
381
|
+
npm install @dialpad/dialtone@next @tiptap/vue-3
|
|
367
382
|
```
|
|
368
383
|
|
|
369
|
-
|
|
370
|
-
|
|
384
|
+
#### Vue 2
|
|
385
|
+
|
|
386
|
+
```shell
|
|
387
|
+
npm install @dialpad/dialtone@next @linusborg/vue-simple-portal @tiptap/vue-2
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### Import packages:
|
|
391
|
+
|
|
392
|
+
#### Dialtone CSS
|
|
393
|
+
|
|
394
|
+
- CSS
|
|
395
|
+
|
|
396
|
+
```css
|
|
397
|
+
@import "@dialpad/dialtone/css";
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
- Javascript
|
|
401
|
+
|
|
402
|
+
```js
|
|
403
|
+
import "@dialpad/dialtone/css";
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
#### Dialtone eslint-plugin
|
|
407
|
+
|
|
408
|
+
```js
|
|
409
|
+
import dialtone from "@dialpad/dialtone/eslint-plugin"
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
#### Dialtone icons
|
|
413
|
+
|
|
414
|
+
- Importing for Vue 2:
|
|
415
|
+
|
|
416
|
+
```js
|
|
417
|
+
// Named import
|
|
418
|
+
import { DtIconArrowUp } from '@dialpad/dialtone-icons/vue2';
|
|
419
|
+
|
|
420
|
+
// Default import (Prefered if using webpack as it is tree-shakeable by default)
|
|
421
|
+
import DtIconArrowUp from '@dialpad/dialtone-icons/vue2/arrow-up';
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
- Importing for Vue 3:
|
|
425
|
+
|
|
426
|
+
```js
|
|
427
|
+
// Named import
|
|
428
|
+
import { DtIconArrowUp } from '@dialpad/dialtone-icons/vue3';
|
|
429
|
+
|
|
430
|
+
// Default import (Prefered if using webpack as it is tree-shakeable by default)
|
|
431
|
+
import DtIconArrowUp from '@dialpad/dialtone-icons/vue3/arrow-up';
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
- Importing json files
|
|
435
|
+
|
|
436
|
+
```js
|
|
437
|
+
import keywords from '@dialpad/dialtone-icons/keywords.json';
|
|
438
|
+
import iconsList from '@dialpad/dialtone-icons/icons.json';
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
#### Dialtone Vue
|
|
442
|
+
|
|
443
|
+
- Vue 2
|
|
444
|
+
|
|
445
|
+
```js
|
|
446
|
+
// Named import
|
|
447
|
+
import { DtButton } from "@dialpad/dialtone/vue2"
|
|
448
|
+
|
|
449
|
+
// Default import (Prefered if using webpack as it is tree-shakeable by default)
|
|
450
|
+
import { DtButton } from "@dialpad/dialtone/vue2/lib/button"
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
- Vue 3
|
|
454
|
+
|
|
455
|
+
```js
|
|
456
|
+
// Named import
|
|
457
|
+
import { DtButton } from "@dialpad/dialtone/vue3"
|
|
458
|
+
|
|
459
|
+
// Default import (Prefered if using webpack as it is tree-shakeable by default)
|
|
460
|
+
import { DtButton } from "@dialpad/dialtone/vue3/lib/button"
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
#### Dialtone Tokens
|
|
464
|
+
|
|
465
|
+
Dialtone tokens doesn't have a default export, so you need to access
|
|
466
|
+
the files directly as following:
|
|
467
|
+
|
|
468
|
+
- CSS
|
|
469
|
+
|
|
470
|
+
```css
|
|
471
|
+
@import "@dialpad/dialtone/tokens/variables-light.css" // Light tokens
|
|
472
|
+
@import "@dialpad/dialtone/tokens/variables-dark.css" // Dark tokens
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
- LESS
|
|
476
|
+
|
|
477
|
+
```less
|
|
478
|
+
@import "@dialpad/dialtone/tokens/variables-light.less" // Light tokens
|
|
479
|
+
@import "@dialpad/dialtone/tokens/variables-dark.less" // Dark tokens
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
- JSON
|
|
483
|
+
|
|
484
|
+
```js
|
|
485
|
+
import "@dialpad/dialtone/tokens/tokens-light.json" // Light tokens
|
|
486
|
+
import "@dialpad/dialtone/tokens/tokens-dark.json" // Dark tokens
|
|
371
487
|
```
|
package/dist/css/dialtone.css
CHANGED
|
@@ -7485,7 +7485,7 @@ body {
|
|
|
7485
7485
|
}
|
|
7486
7486
|
/**
|
|
7487
7487
|
* Do not edit directly
|
|
7488
|
-
* Generated on
|
|
7488
|
+
* Generated on Tue, 14 May 2024 20:31:24 GMT
|
|
7489
7489
|
*/
|
|
7490
7490
|
|
|
7491
7491
|
.dialtone-theme-light {
|
|
@@ -8302,7 +8302,7 @@ body {
|
|
|
8302
8302
|
|
|
8303
8303
|
/**
|
|
8304
8304
|
* Do not edit directly
|
|
8305
|
-
* Generated on
|
|
8305
|
+
* Generated on Tue, 14 May 2024 20:31:24 GMT
|
|
8306
8306
|
*/
|
|
8307
8307
|
|
|
8308
8308
|
.dialtone-theme-dark {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dialpad/dialtone",
|
|
3
|
-
"version": "9.34.
|
|
3
|
+
"version": "9.34.4",
|
|
4
4
|
"description": "Dialpad's Dialtone design system monorepo",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
@@ -151,9 +151,6 @@
|
|
|
151
151
|
"start:dialtone": "nx run-many --target=start --projects=dialtone-css,dialtone-documentation",
|
|
152
152
|
"start:dialtone-vue3": "nx run-many --target=start --projects=dialtone-css,dialtone-vue3",
|
|
153
153
|
"start:dialtone-vue2": "nx run-many --target=start --projects=dialtone-css,dialtone-vue2",
|
|
154
|
-
"release": "./scripts/release.sh",
|
|
155
|
-
"release:alpha": "./scripts/release.sh alpha",
|
|
156
|
-
"release:beta": "./scripts/release.sh beta",
|
|
157
154
|
"test:vue": "vitest run --test-timeout=10000"
|
|
158
155
|
}
|
|
159
156
|
}
|