Fixed typescript typing for aria-labelledby and aria-label

pull/2809/head
Tuğçe Küçükoğlu 2022-07-22 22:40:24 +03:00
parent 5e41e0a56b
commit 556412d925
12 changed files with 77 additions and 25 deletions

View File

@ -70,6 +70,18 @@ const CheckboxProps = [
type: "any", type: "any",
default: "null", default: "null",
description: "Inline style of the input field." description: "Inline style of the input field."
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Used to define a string that labels the element."
} }
]; ];

View File

@ -47,12 +47,6 @@ const ColorPickerProps = [
default: "true", default: "true",
description: "Whether to automatically manage layering." description: "Whether to automatically manage layering."
}, },
{
name: "ariaLabelledBy",
type: "string",
default: "null",
description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{ {
name: "panelClass", name: "panelClass",
type: "string", type: "string",
@ -64,6 +58,18 @@ const ColorPickerProps = [
type: "string", type: "string",
default: "body", default: "body",
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.' description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Used to define a string that labels the element."
} }
]; ];

View File

@ -88,6 +88,18 @@ const TreeSelectProps = [
type: "boolean", type: "boolean",
default: "true", default: "true",
description: "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically." description: "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically."
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Used to define a string that labels the element."
} }
]; ];

View File

@ -16,6 +16,18 @@ const TriStateCheckboxProps = [
type: "any", type: "any",
default: "null", default: "null",
description: "Inline of the component." description: "Inline of the component."
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Used to define a string that labels the element."
} }
]; ];

View File

@ -57,6 +57,14 @@ export interface CheckboxProps {
* *
*/ */
inputProps?: object | undefined; inputProps?: object | undefined;
/**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/
'aria-labelledby'?: string | undefined;
/**
* Establishes a string value that labels the component.
*/
'aria-label'?: string | undefined;
} }
export interface CheckboxSlots { export interface CheckboxSlots {

View File

@ -53,10 +53,6 @@ export interface ColorPickerProps {
* Default value is 0. * Default value is 0.
*/ */
baseZIndex?: number | undefined; baseZIndex?: number | undefined;
/**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/
ariaLabelledBy?: string | undefined;
/** /**
* Style class of the overlay panel. * Style class of the overlay panel.
*/ */

View File

@ -1,7 +1,7 @@
<template> <template>
<div ref="container" :class="containerClass"> <div ref="container" :class="containerClass">
<input ref="input" type="text" :class="inputClass" readonly="readonly" :tabindex="tabindex" :disabled="disabled" <input ref="input" type="text" :class="inputClass" readonly="readonly" :tabindex="tabindex" :disabled="disabled"
@click="onInputClick" @keydown="onInputKeydown" v-if="!inline" :aria-labelledby="ariaLabelledBy"/> @click="onInputClick" @keydown="onInputKeydown" v-if="!inline"/>
<Portal :appendTo="appendTo" :disabled="inline"> <Portal :appendTo="appendTo" :disabled="inline">
<transition name="p-connected-overlay" @enter="onOverlayEnter" @leave="onOverlayLeave" @after-leave="onOverlayAfterLeave"> <transition name="p-connected-overlay" @enter="onOverlayEnter" @leave="onOverlayLeave" @after-leave="onOverlayAfterLeave">
<div :ref="pickerRef" :class="pickerClass" v-if="inline ? true : overlayVisible" @click="onOverlayClick"> <div :ref="pickerRef" :class="pickerClass" v-if="inline ? true : overlayVisible" @click="onOverlayClick">
@ -64,10 +64,6 @@ export default {
type: Number, type: Number,
default: 0 default: 0
}, },
ariaLabelledBy: {
type: String,
default: null
},
appendTo: { appendTo: {
type: String, type: String,
default: 'body' default: 'body'

View File

@ -66,11 +66,11 @@ export interface KnobProps {
/** /**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs. * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/ */
ariaLabelledby?: string | undefined; 'aria-labelledby'?: string | undefined;
/** /**
* Used to define a string that labels the element. * Used to define a string that labels the element.
*/ */
ariaLabel?: string | undefined; 'aria-label'?: string | undefined;
} }
export interface KnobSlots { export interface KnobSlots {

View File

@ -55,11 +55,11 @@ export interface SliderProps {
/** /**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs. * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/ */
ariaLabelledby?: string | undefined; 'aria-labelledby'?: string | undefined;
/** /**
* Used to define a string that labels the element. * Used to define a string that labels the element.
*/ */
ariaLabel?: string | undefined; 'aria-label'?: string | undefined;
} }
export interface SliderSlots { export interface SliderSlots {

View File

@ -82,6 +82,14 @@ export interface TreeSelectProps {
* *
*/ */
inputProps?: object | undefined; inputProps?: object | undefined;
/**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/
'aria-labelledby'?: string | undefined;
/**
* Establishes a string value that labels the component.
*/
'aria-label'?: string | undefined;
} }
export interface TreeSelectSlots { export interface TreeSelectSlots {

View File

@ -13,6 +13,14 @@ export interface TriStateCheckboxProps {
* Style class of the component. * Style class of the component.
*/ */
class?: any; class?: any;
/**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/
'aria-labelledby'?: string | undefined;
/**
* Establishes a string value that labels the component.
*/
'aria-label'?: string | undefined;
} }
export interface TriStateCheckboxSlots { export interface TriStateCheckboxSlots {

View File

@ -99,12 +99,6 @@ export default {
<td>true</td> <td>true</td>
<td>Whether to automatically manage layering.</td> <td>Whether to automatically manage layering.</td>
</tr> </tr>
<tr>
<td>ariaLabelledBy</td>
<td>string</td>
<td>null</td>
<td>Establishes relationships between the component and label(s) where its value should be one or more element IDs.</td>
</tr>
<tr> <tr>
<td>panelClass</td> <td>panelClass</td>
<td>string</td> <td>string</td>