Skip to content

Commit adbcf9b

Browse files
authored
docs: added localization hook for a11y prefix attributes & minor edits (#555)
1 parent 1be72e3 commit adbcf9b

File tree

67 files changed

+109
-109
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+109
-109
lines changed

packages/ebayui-core/src/components/ebay-3d-viewer/3d-viewer.stories.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export default {
3232
},
3333
},
3434
description:
35-
"The text for screen readers to read out when interacting with the 3d player.",
35+
"Localized, the text for screen readers to read out when interacting with the 3d player.",
3636
},
3737
a11yStartText: {
3838
control: { type: "text" },
@@ -42,7 +42,7 @@ export default {
4242
summary: "Click to start",
4343
},
4444
},
45-
description: "Text for start icon to load viewer",
45+
description: "Localized, text for start icon to load viewer",
4646
},
4747
a11yLoadText: {
4848
control: { type: "text" },
@@ -52,7 +52,7 @@ export default {
5252
summary: "Loading",
5353
},
5454
},
55-
description: "Text for loading icon loading viewer",
55+
description: "Localized, text for loading icon loading viewer",
5656
},
5757
errorText: {
5858
control: { type: "text" },

packages/ebayui-core/src/components/ebay-accordion/accordion.stories.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export default {
4646
type: "string",
4747
control: { type: "text" },
4848
description:
49-
"The localized role description to announce the component role for a11y users.",
49+
"Localized, the role description to announce the component role for a11y users.",
5050
table: {
5151
defaultValue: {
5252
summary: "accordion",

packages/ebayui-core/src/components/ebay-avatar/avatar.stories.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export default {
6262
a11yText: {
6363
control: { type: "text" },
6464
description:
65-
'The label to describe the users state as well as their user name. Usually in the format of "Signed in as Bob" or "Signed out"',
65+
'Localized, the label to describe the users state as well as their user name. Usually in the format of "Signed in as Bob" or "Signed out"',
6666
},
6767
knownAspectRatio: {
6868
control: { type: "number" },

packages/ebayui-core/src/components/ebay-breadcrumbs/breadcrumbs.stories.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export default {
3030
argTypes: {
3131
a11yHeadingText: {
3232
control: { type: "text" },
33-
description: "heading for breadcrumb which will be clipped",
33+
description: "Localized, heading for breadcrumb which will be clipped",
3434
},
3535
a11yHeadingTag: {
3636
control: { type: "text" },
@@ -43,7 +43,7 @@ export default {
4343
},
4444
a11yMenuButtonText: {
4545
control: { type: "text" },
46-
description: "a11y text for the collapsed menu button",
46+
description: "Localized, a11y text for the collapsed menu button",
4747
},
4848
href: {
4949
name: "href",

packages/ebayui-core/src/components/ebay-button/button.stories.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export default {
8181
type: { category: "Options" },
8282
},
8383
a11yText: {
84-
description: "aria label for button when bodyState === loading",
84+
description: "Localized, aria label for button when bodyState === loading",
8585
table: {
8686
defaultValue: "",
8787
},

packages/ebayui-core/src/components/ebay-calendar/calendar.stories.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ export default {
169169
type: "text",
170170
control: { type: "text" },
171171
description:
172-
"Text to be read by screen readers when a date is selected",
172+
"Localized, text to be read by screen readers when a date is selected",
173173
table: {
174174
defaultValue: {
175175
summary: "selected",
@@ -180,7 +180,7 @@ export default {
180180
type: "text",
181181
control: { type: "text" },
182182
description:
183-
"Text to be read by screen readers when a date is the start of a range",
183+
"Localized, text to be read by screen readers when a date is the start of a range",
184184
table: {
185185
defaultValue: {
186186
summary: "start of range",
@@ -191,7 +191,7 @@ export default {
191191
type: "text",
192192
control: { type: "text" },
193193
description:
194-
"Text to be read by screen readers when a date is in a range",
194+
"Localized, text to be read by screen readers when a date is in a range",
195195
table: {
196196
defaultValue: {
197197
summary: "in range",
@@ -202,7 +202,7 @@ export default {
202202
type: "text",
203203
control: { type: "text" },
204204
description:
205-
"Text to be read by screen readers when a date is the end of a range",
205+
"Localized, text to be read by screen readers when a date is the end of a range",
206206
table: {
207207
defaultValue: {
208208
summary: "end of range",
@@ -213,7 +213,7 @@ export default {
213213
type: "text",
214214
control: { type: "text" },
215215
description:
216-
"Text to be read by screen readers when a date is the current date",
216+
"Localized, text to be read by screen readers when a date is the current date",
217217
table: {
218218
defaultValue: {
219219
summary: "today",
@@ -224,7 +224,7 @@ export default {
224224
type: "text",
225225
control: { type: "text" },
226226
description:
227-
"Text to be read by screen readers when a date is disabled",
227+
"Localized, text to be read by screen readers when a date is disabled",
228228
table: {
229229
defaultValue: {
230230
summary: "inactive",
@@ -235,7 +235,7 @@ export default {
235235
type: "text",
236236
control: { type: "text" },
237237
description:
238-
"Text to be read by screen readers to separate properties",
238+
"Localized, text to be read by screen readers to separate properties",
239239
table: {
240240
defaultValue: {
241241
summary: " - ",

packages/ebayui-core/src/components/ebay-ccd/ccd.stories.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export default {
6868
},
6969
a11yUnits: {
7070
control: { type: "text" },
71-
description: "The units for the rating used for a11y",
71+
description: "Localized, the units for the rating used for a11y",
7272
table: {
7373
defaultValue: {
7474
summary: "watts",
@@ -77,7 +77,7 @@ export default {
7777
},
7878
a11yText: {
7979
control: { type: "text" },
80-
description: "Overrides the default aria-label text",
80+
description: "Localized, overrides the default aria-label text",
8181
},
8282
},
8383
};

packages/ebayui-core/src/components/ebay-chip/chip.stories.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default {
2727
a11yDeleteButtonText: {
2828
control: { type: "text" },
2929
description:
30-
"A11y text for the delete button, also determines if delete button is shown",
30+
"Localized, a11y text for the delete button, also determines if delete button is shown",
3131
},
3232
onDelete: {
3333
action: "on-delete",

packages/ebayui-core/src/components/ebay-chips-combobox/chips-combobox.stories.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export default {
4545
},
4646
a11yDeleteButtonText: {
4747
control: { type: "text" },
48-
description: "The aria-label for the delete button on each chip.",
48+
description: "Localized, the aria-label for the delete button on each chip.",
4949
},
5050
roledescription: {
5151
control: { type: "text" },

packages/ebayui-core/src/components/ebay-date-textbox/date-textbox.stories.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ export default {
168168
type: "text",
169169
control: { type: "text" },
170170
description:
171-
"Text to be read by screen readers when a date is selected",
171+
"Localized, text to be read by screen readers when a date is selected",
172172
table: {
173173
defaultValue: {
174174
summary: "selected",
@@ -179,7 +179,7 @@ export default {
179179
type: "text",
180180
control: { type: "text" },
181181
description:
182-
"Text to be read by screen readers when a date is the start of a range",
182+
"Localized, text to be read by screen readers when a date is the start of a range",
183183
table: {
184184
defaultValue: {
185185
summary: "start of range",
@@ -190,7 +190,7 @@ export default {
190190
type: "text",
191191
control: { type: "text" },
192192
description:
193-
"Text to be read by screen readers when a date is in a range",
193+
"Localized, text to be read by screen readers when a date is in a range",
194194
table: {
195195
defaultValue: {
196196
summary: "in range",
@@ -201,7 +201,7 @@ export default {
201201
type: "text",
202202
control: { type: "text" },
203203
description:
204-
"Text to be read by screen readers when a date is the end of a range",
204+
"Localized, text to be read by screen readers when a date is the end of a range",
205205
table: {
206206
defaultValue: {
207207
summary: "end of range",
@@ -212,7 +212,7 @@ export default {
212212
type: "text",
213213
control: { type: "text" },
214214
description:
215-
"Text to be read by screen readers to separate properties",
215+
"Localized, text to be read by screen readers to separate properties",
216216
table: {
217217
defaultValue: {
218218
summary: " - ",
@@ -223,7 +223,7 @@ export default {
223223
type: "text",
224224
control: { type: "text" },
225225
description:
226-
"A11y label for the button that opens the calendar popover",
226+
"Localized, a11y label for the button that opens the calendar popover",
227227
table: { defaultValue: { summary: "open calendar" } },
228228
},
229229
inputPlaceholderText: {

0 commit comments

Comments
 (0)