primevue-mirror/api-generator/components/password.js

212 lines
5.7 KiB
JavaScript
Raw Normal View History

const PasswordProps = [
{
2022-09-14 14:26:41 +00:00
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
2022-09-14 14:26:41 +00:00
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
2022-09-14 14:26:41 +00:00
name: 'promptLabel',
type: 'string',
default: 'null',
description: 'Text to prompt password entry. Defaults to PrimeVue Locale configuration.'
},
{
2022-09-14 14:26:41 +00:00
name: 'mediumRegex',
type: 'string',
default: '^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,})',
description: 'Regex for a medium level password.'
},
{
2022-09-14 14:26:41 +00:00
name: 'strongRegex',
type: 'string',
default: '^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})',
description: 'Regex for a strong level password.'
},
{
2022-09-14 14:26:41 +00:00
name: 'weakLabel',
type: 'string',
default: 'null',
description: 'Text for a weak password. Defaults to PrimeVue Locale configuration.'
},
{
2022-09-14 14:26:41 +00:00
name: 'mediumLabel',
type: 'string',
default: 'null',
description: 'Text for a medium password. Defaults to PrimeVue Locale configuration.'
},
{
2022-09-14 14:26:41 +00:00
name: 'strongLabel',
type: 'string',
default: 'null',
description: 'Text for a strong password. Defaults to PrimeVue Locale configuration.'
},
{
2022-09-14 14:26:41 +00:00
name: 'feedback',
type: 'boolean',
default: 'true',
description: 'Whether to show the strength indicator or not.'
},
{
2022-09-14 14:26:41 +00:00
name: 'toogleMask',
type: 'boolean',
default: 'false',
description: 'Whether to show an icon to display the password as plain text.'
},
{
2022-09-14 14:26:41 +00:00
name: 'appendTo',
type: 'string',
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.'
},
{
2022-09-14 14:26:41 +00:00
name: 'hideIcon',
type: 'string',
default: 'null',
2022-09-14 14:26:41 +00:00
description: 'Icon to hide displaying the password as plain text.'
},
{
2022-09-14 14:26:41 +00:00
name: 'showIcon',
type: 'string',
default: 'null',
2022-09-14 14:26:41 +00:00
description: 'Icon to show displaying the password as plain text.'
},
{
2022-09-14 14:26:41 +00:00
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text for the input.'
},
2024-01-31 08:01:02 +00:00
{
name: 'invalid',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should have invalid state style.'
},
{
name: 'variant',
type: 'string',
default: 'outlined',
description: 'Specifies the input variant of the component.'
},
{
2022-09-14 14:26:41 +00:00
name: 'required',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that an input field must be filled out before submitting the form.'
},
{
2022-09-14 14:26:41 +00:00
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
2022-09-14 14:26:41 +00:00
name: 'inputStyle',
type: 'object',
2022-09-14 14:26:41 +00:00
default: 'null',
description: 'Inline style of the input field.'
},
{
2022-09-14 14:26:41 +00:00
name: 'inputClass',
type: 'string | object',
2022-09-14 14:26:41 +00:00
default: 'null',
description: 'Style class of the input field.'
},
{
2022-09-14 14:26:41 +00:00
name: 'inputProps',
type: 'object',
default: 'null',
2023-08-01 14:01:12 +00:00
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
},
{
2022-09-14 14:26:41 +00:00
name: 'panelId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying overlay panel element.'
},
{
2022-09-14 14:26:41 +00:00
name: 'panelClass',
type: 'string | object',
2022-09-14 14:26:41 +00:00
default: 'null',
description: 'Style class of the overlay panel.'
},
{
2022-09-14 14:26:41 +00:00
name: 'panelStyle',
type: 'object',
2022-09-14 14:26:41 +00:00
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
2022-09-14 14:26:41 +00:00
name: 'panelProps',
type: 'object',
default: 'null',
2023-08-01 14:01:12 +00:00
description: 'Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
2023-05-05 14:58:54 +00:00
},
{
name: 'pt',
type: 'any',
default: 'null',
2023-08-01 14:01:12 +00:00
description: 'Used to pass attributes to DOM elements inside the component.'
2023-07-06 13:20:37 +00:00
},
{
name: 'unstyled',
type: 'boolean',
default: 'false',
description: 'When enabled, it removes component related styles in the core.'
}
];
const PasswordSlots = [
{
2022-09-14 14:26:41 +00:00
name: 'header',
description: "Custom content for the component's header."
},
{
2022-09-14 14:26:41 +00:00
name: 'content',
description: 'Custom content for the component.'
},
{
2022-09-14 14:26:41 +00:00
name: 'footer',
description: "Custom content for the component's footer."
},
{
name: 'hideicon',
description: 'Custom content for the hide icon.'
},
{
name: 'showicon',
description: 'Custom content for the show icon.'
}
];
const PasswordEmits = [
{
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
];
module.exports = {
password: {
2022-09-14 14:26:41 +00:00
name: 'Password',
description: 'Password displays strength indicator for password fields.',
props: PasswordProps,
slots: PasswordSlots,
events: PasswordEmits
}
};