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

121 lines
3.1 KiB
JavaScript
Raw Normal View History

const SelectButtonProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
},
{
name: "options",
type: "array",
default: "null",
description: "An array of selectitems to display as the available options."
},
{
name: "optionLabel",
type: "string",
default: "null",
description: "Property name or getter function to use as the label of an option."
},
{
name: "optionValue",
type: "string",
default: "null",
description: "Property name or getter function to use as the value of an option, defaults to the option itself when not defined."
},
{
name: "optionDisabled",
type: "boolean",
default: "null",
description: "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined."
},
{
name: "multiple",
type: "boolean",
default: "false",
description: "When specified, allows selecting multiple values."
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
},
{
name: "unselectable",
type: "boolean",
default: "true",
description: "Whether selection can be cleared."
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying element."
}
];
const SelectButtonEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
},
{
name: "event.value",
type: "any",
description: "Single value or an array of values that are selected."
}
]
},
{
name: "focus",
description: "Callback to invoke on focus.",
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
}
]
},
{
name: "blur",
description: "Callback to invoke on blur.",
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
}
]
}
];
const SelectButtonSlots = [
{
name: "option",
description: "Custom content for the item's option"
}
];
module.exports = {
selectbutton: {
name: "SelectButton",
description: "SelectButton is a form component to choose a value from a list of options using button elements.",
props: SelectButtonProps,
events: SelectButtonEvents,
slots: SelectButtonSlots
}
};