Skip to content

Commit c80061f

Browse files
docs(tabs, skeleton, rich-text-editor, emoji, avatar): DLT-3347 update doc page code examples (#1221)
1 parent a4a21f7 commit c80061f

6 files changed

Lines changed: 93 additions & 143 deletions

File tree

apps/dialtone-documentation/docs/.vuepress/exampleComponents/ExampleTabs.vue

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<template>
22
<dt-tab-group
3+
label="Label Example Group"
34
:size="size"
45
:inverted="inverted"
56
:borderless="borderless"
@@ -12,26 +13,19 @@
1213
panel-id="2"
1314
selected
1415
>
15-
<p>
16-
First tab
17-
</p>
16+
First tab
1817
</dt-tab>
1918
<dt-tab
2019
id="3"
2120
panel-id="4"
2221
>
23-
<p>
24-
Second tab
25-
</p>
22+
Second tab
2623
</dt-tab>
2724
<dt-tab
2825
id="5"
2926
panel-id="6"
30-
label="Third Label"
3127
>
32-
<p>
33-
Third tab
34-
</p>
28+
Third tab
3529
</dt-tab>
3630
</template>
3731
<div

apps/dialtone-documentation/docs/components/avatar.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,22 +206,22 @@ vueCode='
206206
<dt-icon-user :size="iconSize" />
207207
</template>
208208
</dt-avatar>
209-
<dt-avatar size="sm" icon-name="user">
209+
<dt-avatar size="sm">
210210
<template #icon="{ iconSize }">
211211
<dt-icon-user :size="iconSize" />
212212
</template>
213213
</dt-avatar>
214-
<dt-avatar size="md" icon-name="user">
214+
<dt-avatar size="md">
215215
<template #icon="{ iconSize }">
216216
<dt-icon-user :size="iconSize" />
217217
</template>
218218
</dt-avatar>
219-
<dt-avatar size="lg" icon-name="user">
219+
<dt-avatar size="lg">
220220
<template #icon="{ iconSize }">
221221
<dt-icon-user :size="iconSize" />
222222
</template>
223223
</dt-avatar>
224-
<dt-avatar size="xl" icon-name="user">
224+
<dt-avatar size="xl">
225225
<template #icon="{ iconSize }">
226226
<dt-icon-user :size="iconSize" />
227227
</template>

apps/dialtone-documentation/docs/components/emoji.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ storybook: https://dialtone.dialpad.com/vue/?path=/story/components-emoji--defau
2323
<code-example-tabs
2424
htmlCode='
2525
<div>
26-
<span class="d-emoji d-icon d-icon--size-500" code=":smile:" size="500">
26+
<span class="d-emoji d-icon d-icon--size-500">
2727
<div aria-busy="true" role="status" aria-label="" class="d-icon d-icon--size-500" style="display: none;">
2828
<div
2929
class="d-skeleton-placeholder d-bar-circle d-skeleton-placeholder--animate"
@@ -42,7 +42,7 @@ htmlCode='
4242
'
4343
vueCode='
4444
<dt-emoji
45-
code="smile"
45+
code=":smile:"
4646
size="500"
4747
/>
4848
'

apps/dialtone-documentation/docs/components/rich-text-editor.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ vueCode='
2323
v-model="value"
2424
:editable="true"
2525
input-aria-label="this is a descriptive label"
26-
:input-class="$attrs.inputClass"
27-
:output-format="$attrs.outputFormat"
26+
output-format="html"
2827
:auto-focus="false"
2928
placeholder="Type here..."
3029
:link="true"
@@ -117,12 +116,11 @@ vueCode='
117116
v-model="value"
118117
:editable="true"
119118
input-aria-label="this is a descriptive label"
120-
:input-class="$attrs.inputClass"
121-
:output-format="$attrs.outputFormat"
119+
output-format="html"
122120
:auto-focus="false"
123121
placeholder="Type here..."
124122
:link="true"
125-
:mentionSuggestion="{ items }"
123+
:mention-suggestion="{ items }"
126124
/>
127125
'
128126
/>

apps/dialtone-documentation/docs/components/skeleton.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,29 +60,29 @@ figma: planned
6060

6161
<code-well-header>
6262
<div class="d-w50p">
63-
<dt-skeleton :animate="false" arial-label="Loading" ref="defaultExample" />
63+
<dt-skeleton :animate="false" aria-label="Loading" ref="defaultExample" />
6464
</div>
6565
</code-well-header>
6666

6767
<code-example-tabs
6868
:htmlCode="() => $refs.defaultExample"
6969
vueCode='
70-
<dt-skeleton :animate="false" arial-label="Loading" />
70+
<dt-skeleton :animate="false" aria-label="Loading" />
7171
'
7272
showHtmlWarning />
7373

7474
### Animation
7575

7676
<code-well-header>
7777
<div class="d-w50p">
78-
<dt-skeleton arial-label="Loading" ref="animationExample" />
78+
<dt-skeleton aria-label="Loading" ref="animationExample" />
7979
</div>
8080
</code-well-header>
8181

8282
<code-example-tabs
8383
:htmlCode="() => $refs.animationExample"
8484
vueCode='
85-
<dt-skeleton arial-label="Loading" />
85+
<dt-skeleton aria-label="Loading" />
8686
'
8787
/>
8888

@@ -98,7 +98,7 @@ To customize a non-animating Skeleton background color modify the `--placeholder
9898
style: '--placeholder-from-color: var(--dt-color-blue-400)',
9999
}"
100100
ref="customExample"
101-
arial-label="Loading"
101+
aria-label="Loading"
102102
/>
103103
</div>
104104
</code-well-header>
@@ -111,7 +111,7 @@ vueCode='
111111
:text-option="{
112112
style: `--placeholder-from-color: var(--dt-color-blue-400)`,
113113
}"
114-
arial-label="Loading"
114+
aria-label="Loading"
115115
/>
116116
'
117117
showHtmlWarning />
@@ -125,7 +125,7 @@ Customize an animating Skeleton by modifying the `--placeholder-from-color` and
125125
style: '--placeholder-from-color: var(--dt-color-blue-400); --placeholder-to-color: var(--dt-color-blue-200);',
126126
}"
127127
ref="customAnimateExample"
128-
arial-label="Loading"
128+
aria-label="Loading"
129129
/>
130130
</div>
131131
</code-well-header>
@@ -137,7 +137,7 @@ vueCode='
137137
:text-option="{
138138
style: `--placeholder-from-color: var(--dt-color-blue-400); --placeholder-to-color: var(--dt-color-blue-200);`,
139139
}"
140-
arial-label="Loading"
140+
aria-label="Loading"
141141
/>
142142
'
143143
showHtmlWarning />

0 commit comments

Comments
 (0)