vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Lint changes

pull/3420/head
Bahadir Sofuoglu 2022-09-14 17:26:41 +03:00
parent eb2de5460c
commit 4d3a071e66
291 changed files with 28450 additions and 26621 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
.eslintrc.js Normal file
View File

@ -0,0 +1,90 @@
module.exports = {
root: true,
env: {
node: true,
jest: true
},
extends: ['plugin:vue/vue3-essential', 'eslint:recommended', 'prettier'],
parserOptions: {
parser: '@babel/eslint-parser',
requireConfigFile: false
},
plugins: ['prettier'],
rules: {
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'no-fallthrough': 'off',
'vue/this-in-template': ['error', 'never'],
'vue/component-tags-order': [
'error',
{
order: ['template', 'script', 'style']
}
],
'vue/require-explicit-emits': [
'error',
{
allowProps: false
}
],
'vue/attributes-order': [
'error',
{
order: ['CONDITIONALS', 'LIST_RENDERING', 'DEFINITION', ['UNIQUE', 'SLOT'], 'RENDER_MODIFIERS', 'GLOBAL', 'TWO_WAY_BINDING', 'OTHER_DIRECTIVES', ['OTHER_ATTR', 'EVENTS'], 'CONTENT'],
alphabetical: false
}
],
'vue/order-in-components': [
'error',
{
order: [
'el',
'name',
'key',
'parent',
'functional',
'extends',
'mixins',
['delimiters', 'comments'],
'ROUTER_GUARDS',
'layout',
'middleware',
'validate',
'scrollToTop',
'transition',
'loading',
'inheritAttrs',
'model',
'emits',
'setup',
'fetch',
'head',
['props', 'propsData'],
['provide', 'inject'],
'asyncData',
'data',
'watch',
'watchQuery',
'LIFECYCLE_HOOKS',
'methods',
'computed',
['components', 'directives', 'filters'],
['template', 'render'],
'renderError'
]
}
],
'padding-line-between-statements': [
'error',
{ blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
{ blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] },
{ blankLine: 'any', prev: ['case', 'default'], next: 'break' },
{ blankLine: 'any', prev: 'case', next: 'case' },
{ blankLine: 'always', prev: '*', next: 'return' },
{ blankLine: 'always', prev: 'block', next: '*' },
{ blankLine: 'always', prev: '*', next: 'block' },
{ blankLine: 'always', prev: 'block-like', next: '*' },
{ blankLine: 'always', prev: '*', next: 'block-like' }
]
}
};

9
.prettierignore Normal file
View File

@ -0,0 +1,9 @@
# Ignore artifacts:
build
coverage
dist
out
public
styles
node_modules
.vscode

10
.prettierrc.json Normal file
View File

@ -0,0 +1,10 @@
{
"useTabs": false,
"tabWidth": 4,
"trailingComma": "none",
"semi": true,
"singleQuote": true,
"vueIndentScriptAndStyle": false,
"printWidth": 250,
"bracketSameLine": false
}

6
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,6 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
]
}

19
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,19 @@
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.organizeImports": true
},
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
}
}

87
api-generator/build-api.js
View File

@ -1,37 +1,37 @@
const fs = require("fs");
const path = require("path");
const fs = require('fs');
const path = require('path');
const rootDir = path.resolve(__dirname, "../");
const distDir = path.resolve(rootDir, "dist");
const componentPath = path.join(__dirname, "./components");
const rootDir = path.resolve(__dirname, '../');
const distDir = path.resolve(rootDir, 'dist');
const componentPath = path.join(__dirname, './components');
// Import project `package.json`
const pkg = require(path.resolve(rootDir, "package.json"));
const libraryName = "PrimeVue";
const pkg = require(path.resolve(rootDir, 'package.json'));
const libraryName = 'PrimeVue';
const libraryVersion = pkg.version;
const showcaseURL = "https://primefaces.org/primevue/showcase/#/";
const showcaseURL = 'https://primefaces.org/primevue/showcase/#/';
const fileModules = {},
veturTags = {},
veturAttributes = {};
const files = fs.readdirSync(componentPath);
files.forEach(file => {
files.forEach((file) => {
const { name } = path.parse(file);
fileModules[name] = require(`./components//${name}`);
});
const webTypes = {
$schema: "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
framework: "vue",
$schema: 'https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json',
framework: 'vue',
name: libraryName,
version: libraryVersion,
contributions: {
html: {
"types-syntax": "typescript",
"description-markup": "markdown",
'types-syntax': 'typescript',
'description-markup': 'markdown',
tags: [],
attributes: []
}
@ -41,12 +41,12 @@ const webTypes = {
const addURL = (attr, url, value) => {
const newArray = [];
attr.forEach(att => {
attr.forEach((att) => {
const newObj = {};
Object.keys(att).forEach(key => {
Object.keys(att).forEach((key) => {
newObj[key] = att[key];
if (key === value) newObj["doc-url"] = url;
if (key === value) newObj['doc-url'] = url;
});
newArray.push(newObj);
@ -55,8 +55,8 @@ const addURL = (attr, url, value) => {
return newArray;
};
const createWebTypes = component => {
const url = showcaseURL + `${component["doc-url"] ? component["doc-url"] : component.name.toLowerCase()}`;
const createWebTypes = (component) => {
const url = showcaseURL + `${component['doc-url'] ? component['doc-url'] : component.name.toLowerCase()}`;
// components
const tag = {
@ -65,7 +65,7 @@ const createWebTypes = component => {
module: libraryName,
symbol: component.name
},
"doc-url": url,
'doc-url': url,
description: component.description
};
@ -77,44 +77,43 @@ const createWebTypes = component => {
symbol: component.name
},
description: component.description,
"doc-url": url,
'doc-url': url,
value: {
kind: "expression",
type: "function"
kind: 'expression',
type: 'function'
}
};
if (component.props) {
tag.attributes = addURL(component.props, url, "default");
tag.attributes.forEach(k => {
k["value"] = {
kind: "expression",
type: k["type"]
tag.attributes = addURL(component.props, url, 'default');
tag.attributes.forEach((k) => {
k['value'] = {
kind: 'expression',
type: k['type']
};
delete k["type"];
delete k['type'];
});
}
if (component.events) {
tag.events = addURL(component.events, url, "name");
tag.events.forEach(k => {
tag.events = addURL(component.events, url, 'name');
tag.events.forEach((k) => {
if (k.arguments) {
k.arguments = addURL(k.arguments, url, "name");
k.arguments = addURL(k.arguments, url, 'name');
}
});
}
if (component.slots) {
tag.slots = addURL(component.slots, url, "name");
tag.slots = addURL(component.slots, url, 'name');
}
if (component["vue-modifiers"]) {
if (component['vue-modifiers']) {
attribute.required = false;
attribute["vue-modifiers"] = addURL(component["vue-modifiers"], url, "name");
attribute['vue-modifiers'] = addURL(component['vue-modifiers'], url, 'name');
if (attribute["vue-modifiers"].length < 1)
delete attribute["vue-modifiers"];
if (attribute['vue-modifiers'].length < 1) delete attribute['vue-modifiers'];
webTypes.contributions.html.attributes.push(attribute);
}
@ -122,10 +121,10 @@ const createWebTypes = component => {
webTypes.contributions.html.tags.push(tag);
};
const createVeturTags = component => {
const createVeturTags = (component) => {
const attributes = [];
if (component.props) {
component.props.forEach(comp => {
component.props.forEach((comp) => {
attributes.push(comp.name);
});
}
@ -137,9 +136,9 @@ const createVeturTags = component => {
}
};
const createVeturAttributes = component => {
const createVeturAttributes = (component) => {
if (component.props) {
component.props.forEach(comp => {
component.props.forEach((comp) => {
veturAttributes[component.name.toLowerCase() + `/${comp.name}`] = {
description: comp.description,
type: comp.type
@ -148,17 +147,17 @@ const createVeturAttributes = component => {
}
};
Object.keys(fileModules).forEach(p => {
Object.keys(fileModules).forEach((p) => {
createWebTypes(fileModules[p][p]);
createVeturTags(fileModules[p][p]);
createVeturAttributes(fileModules[p][p]);
});
const webTypesJson = JSON.stringify(webTypes, null, 2);
fs.writeFileSync(path.resolve(distDir, "web-types.json"), webTypesJson);
fs.writeFileSync(path.resolve(distDir, 'web-types.json'), webTypesJson);
const veturTagsJson = JSON.stringify(veturTags, null, 2);
fs.writeFileSync(path.resolve(distDir, "vetur-tags.json"), veturTagsJson);
fs.writeFileSync(path.resolve(distDir, 'vetur-tags.json'), veturTagsJson);
const veturAttributesJson = JSON.stringify(veturAttributes, null, 2);
fs.writeFileSync(path.resolve(distDir, "vetur-attributes.json"), veturAttributesJson);
fs.writeFileSync(path.resolve(distDir, 'vetur-attributes.json'), veturAttributesJson);

108
api-generator/components/accordion.js
View File

@ -1,94 +1,94 @@
const AccordionProps = [
{
name: "multiple",
type: "boolean",
default: "false",
description: "When enabled, multiple tabs can be activated at the same time."
name: 'multiple',
type: 'boolean',
default: 'false',
description: 'When enabled, multiple tabs can be activated at the same time.'
},
{
name: "activeIndex",
type: "number|array",
default: "null",
description: "Index of the active tab or an array of indexes in multiple mode."
name: 'activeIndex',
type: 'number|array',
default: 'null',
description: 'Index of the active tab or an array of indexes in multiple mode.'
},
{
name: "lazy",
type: "boolean",
default: "false",
description: "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css."
name: 'lazy',
type: 'boolean',
default: 'false',
description: 'When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css.'
},
{
name: "expandIcon",
type: "string",
default: "pi-chevron-right",
description: "Icon of a collapsed tab."
name: 'expandIcon',
type: 'string',
default: 'pi-chevron-right',
description: 'Icon of a collapsed tab.'
},
{
name: "collapseIcon",
type: "string",
default: "pi-chevron-down",
description: "Icon of a expanded tab."
name: 'collapseIcon',
type: 'string',
default: 'pi-chevron-down',
description: 'Icon of a expanded tab.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused tab is activated."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused tab is activated.'
}
];
const AccordionEvents = [
{
name: "tab-open",
description: "Callback to invoke when a tab gets expanded.",
name: 'tab-open',
description: 'Callback to invoke when a tab gets expanded.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "index",
type: "number",
description: "Opened tab index"
name: 'index',
type: 'number',
description: 'Opened tab index'
}
]
},
{
name: "tab-close",
description: "Callback to invoke when an active tab is collapsed by clicking on the header.",
name: 'tab-close',
description: 'Callback to invoke when an active tab is collapsed by clicking on the header.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "index",
type: "number",
description: "Closed tab index"
name: 'index',
type: 'number',
description: 'Closed tab index'
}
]
},
{
name: "tab-click",
description: "Callback to invoke when an active tab is clicked.",
name: 'tab-click',
description: 'Callback to invoke when an active tab is clicked.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "index",
type: "number",
description: "Index of the clicked tab"
name: 'index',
type: 'number',
description: 'Index of the clicked tab'
}
]
}
@ -96,8 +96,8 @@ const AccordionEvents = [
module.exports = {
accordion: {
name: "Accordion",
description: "Accordion groups a collection of contents in tabs.",
name: 'Accordion',
description: 'Accordion groups a collection of contents in tabs.',
props: AccordionProps,
events: AccordionEvents
}

76
api-generator/components/accordiontab.js
View File

@ -1,64 +1,64 @@
const AccordionTabProps = [
{
name: "header",
type: "string",
default: "null",
description: "Orientation of tab headers."
name: 'header',
type: 'string',
default: 'null',
description: 'Orientation of tab headers.'
},
{
name: "headerStyle",
type: "any",
default: "null",
description: "Inline style of the tab header."
name: 'headerStyle',
type: 'any',
default: 'null',
description: 'Inline style of the tab header.'
},
{
name: "headerClass",
type: "any",
default: "null",
description: "Style class of the tab header."
name: 'headerClass',
type: 'any',
default: 'null',
description: 'Style class of the tab header.'
},
{
name: "headerProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the tab header."
name: 'headerProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the tab header.'
},
{
name: "headerActionProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header."
name: 'headerActionProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.'
},
{
name: "contentStyle",
type: "any",
default: "null",
description: "Inline style of the tab content."
name: 'contentStyle',
type: 'any',
default: 'null',
description: 'Inline style of the tab content.'
},
{
name: "contentClass",
type: "any",
default: "null",
description: "Style class of the tab content."
name: 'contentClass',
type: 'any',
default: 'null',
description: 'Style class of the tab content.'
},
{
name: "contentProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the tab content."
name: 'contentProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the tab content.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "Whether the tab is disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'Whether the tab is disabled.'
}
];
module.exports = {
accordiontab: {
name: "AccordionTab",
description: "Accordion element consists of one or more AccordionTab elements.",
name: 'AccordionTab',
description: 'Accordion element consists of one or more AccordionTab elements.',
props: AccordionTabProps
}
};

460
api-generator/components/autocomplete.js
View File

@ -1,404 +1,404 @@
const AutoCompleteProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "suggestions",
type: "array",
default: "null",
description: "An array of suggestions to display."
name: 'suggestions',
type: 'array',
default: 'null',
description: 'An array of suggestions to display.'
},
{
name: "field",
type: "any",
default: "null",
description: "Property name or getter function of a suggested object to resolve and display."
name: 'field',
type: 'any',
default: 'null',
description: 'Property name or getter function of a suggested object to resolve and display.'
},
{
name: "optionLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option."
name: 'optionLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option.'
},
{
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: '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: "optionGroupLabel",
type: "string",
default: "null",
description: "Property name or getter function to use as the label of an option group."
name: 'optionGroupLabel',
type: 'string',
default: 'null',
description: 'Property name or getter function to use as the label of an option group.'
},
{
name: "optionGroupChildren",
type: "string",
default: "null",
description: "Property name or getter function that refers to the children options of option group."
name: 'optionGroupChildren',
type: 'string',
default: 'null',
description: 'Property name or getter function that refers to the children options of option group.'
},
{
name: "scrollHeight",
type: "string",
default: "200px",
description: "Maximum height of the suggestions panel."
name: 'scrollHeight',
type: 'string',
default: '200px',
description: 'Maximum height of the suggestions panel.'
},
{
name: "dropdown",
type: "boolean",
default: "false",
description: "Displays a button next to the input field when enabled."
name: 'dropdown',
type: 'boolean',
default: 'false',
description: 'Displays a button next to the input field when enabled.'
},
{
name: "dropdownMode",
type: "string",
default: "blank",
name: 'dropdownMode',
type: 'string',
default: 'blank',
description: 'Specifies the behavior dropdown button. Default "blank" mode sends an empty string and "current" mode sends the input value.'
},
{
name: "autoHighlight",
type: "boolean",
name: 'autoHighlight',
type: 'boolean',
default: false,
description: "Highlights automatically the first item of the dropdown to be selected."
description: 'Highlights automatically the first item of the dropdown to be selected.'
},
{
name: "multiple",
type: "boolean",
default: "false",
description: "Specifies if multiple values can be selected."
name: 'multiple',
type: 'boolean',
default: 'false',
description: 'Specifies if multiple values can be selected.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Default text to display when no option is selected."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Default text to display when no option is selected.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'A property to uniquely identify an option.'
},
{
name: "minLength",
type: "number",
default: "1",
description: "Minimum number of characters to initiate a search."
name: 'minLength',
type: 'number',
default: '1',
description: 'Minimum number of characters to initiate a search.'
},
{
name: "delay",
type: "number",
default: "300",
description: "Delay between keystrokes to wait before sending a query."
name: 'delay',
type: 'number',
default: '300',
description: 'Delay between keystrokes to wait before sending a query.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
name: "forceSelection",
type: "boolean",
default: "false",
description: "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions."
name: 'forceSelection',
type: 'boolean',
default: 'false',
description: 'When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions.'
},
{
name: "completeOnFocus",
type: "boolean",
default: "false",
description: "Whether to run a query when input receives focus."
name: 'completeOnFocus',
type: 'boolean',
default: 'false',
description: 'Whether to run a query when input receives focus.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "object",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'object',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
},
{
name: "panelStyle",
type: "object",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'object',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner",
description: "Icon to display in loading state."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner',
description: 'Icon to display in loading state.'
},
{
name: "virtualScrollerOptions",
type: "object",
default: "null",
description: "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it."
name: 'virtualScrollerOptions',
type: 'object',
default: 'null',
description: 'Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.'
},
{
name: "autoOptionFocus",
type: "boolean",
default: "true",
description: "Whether to focus on the first visible or selected element when the overlay panel is shown."
name: 'autoOptionFocus',
type: 'boolean',
default: 'true',
description: 'Whether to focus on the first visible or selected element when the overlay panel is shown.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused option is selected."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused option is selected.'
},
{
name: "searchLocale",
type: "string",
default: "undefined",
name: 'searchLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in searching. The default locale is the host environment's current locale."
},
{
name: "searchMessage",
type: "string",
default: "{0} results are available",
description: "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
name: 'searchMessage',
type: 'string',
default: '{0} results are available',
description: 'Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "selectionMessage",
type: "string",
default: "{0} items selected",
description: "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
name: 'selectionMessage',
type: 'string',
default: '{0} items selected',
description: 'Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySelectionMessage",
type: "string",
default: "No selected item",
description: "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
name: 'emptySelectionMessage',
type: 'string',
default: 'No selected item',
description: 'Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySearchMessage",
type: "string",
default: "No results found",
description: "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
name: 'emptySearchMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
}
];
const AutoCompleteEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Selected option value"
name: 'event.value',
type: 'string',
description: 'Selected option value'
}
]
},
{
name: "focus",
description: "Callback to invoke when component receives focus.",
name: 'focus',
description: 'Callback to invoke when component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when component loses focus.",
name: 'blur',
description: 'Callback to invoke when component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "item-select",
description: "Callback to invoke when a suggestion is selected.",
name: 'item-select',
description: 'Callback to invoke when a suggestion is selected.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "value",
type: "object",
description: "Selected item"
name: 'value',
type: 'object',
description: 'Selected item'
}
]
},
{
name: "item-unselect",
description: "Callback to invoke when a selected value is removed.",
name: 'item-unselect',
description: 'Callback to invoke when a selected value is removed.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "value",
type: "object",
description: "Unselected item"
name: 'value',
type: 'object',
description: 'Unselected item'
}
]
},
{
name: "dropdown-click",
description: "Callback to invoke to when dropdown button is clicked.",
name: 'dropdown-click',
description: 'Callback to invoke to when dropdown button is clicked.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "query",
type: "string",
description: "Current value of the input field"
name: 'query',
type: 'string',
description: 'Current value of the input field'
}
]
},
{
name: "clear",
description: "Callback to invoke when input is cleared by the user."
name: 'clear',
description: 'Callback to invoke when input is cleared by the user.'
},
{
name: "complete",
description: "Callback to invoke to search for suggestions.",
name: 'complete',
description: 'Callback to invoke to search for suggestions.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "query",
type: "string",
description: "Value to search with"
name: 'query',
type: 'string',
description: 'Value to search with'
}
]
},
{
name: "before-show",
description: "Callback to invoke before the overlay is shown."
name: 'before-show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "before-hide",
description: "Callback to invoke before the overlay is hidden."
name: 'before-hide',
description: 'Callback to invoke before the overlay is hidden.'
},
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
}
];
const AutoCompleteSlots = [
{
name: "chip",
description: "Custom content for the chip display."
name: 'chip',
description: 'Custom content for the chip display.'
},
{
name: "header",
description: "Custom content for the component header."
name: 'header',
description: 'Custom content for the component header.'
},
{
name: "footer",
description: "Custom content for the component footer."
name: 'footer',
description: 'Custom content for the component footer.'
},
{
name: "item",
description: "Custom content for the item."
name: 'item',
description: 'Custom content for the item.'
},
{
name: "option",
description: "Custom content for the item."
name: 'option',
description: 'Custom content for the item.'
},
{
name: "optiongroup",
description: "Custom content for the optiongroup item."
name: 'optiongroup',
description: 'Custom content for the optiongroup item.'
},
{
name: "content",
description: "Custom content for the virtual scroller"
name: 'content',
description: 'Custom content for the virtual scroller'
},
{
name: "loader",
description: "Custom content for the virtual scroller loader items"
name: 'loader',
description: 'Custom content for the virtual scroller loader items'
}
];
module.exports = {
autocomplete: {
name: "AutoComplete",
description: "AutoComplete is an input component that provides real-time suggestions when being typed.",
name: 'AutoComplete',
description: 'AutoComplete is an input component that provides real-time suggestions when being typed.',
props: AutoCompleteProps,
events: AutoCompleteEvents,
slots: AutoCompleteSlots

46
api-generator/components/avatar.js
View File

@ -1,47 +1,47 @@
const AvatarProps = [
{
name: "label",
type: "string",
default: "null",
description: "Defines the text to display."
name: 'label',
type: 'string',
default: 'null',
description: 'Defines the text to display.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Defines the icon to display."
name: 'icon',
type: 'string',
default: 'null',
description: 'Defines the icon to display.'
},
{
name: "image",
type: "string",
default: "null",
description: "Defines the image to display."
name: 'image',
type: 'string',
default: 'null',
description: 'Defines the image to display.'
},
{
name: "size",
type: "string",
default: "null",
name: 'size',
type: 'string',
default: 'null',
description: 'Size of the element, valid options are "large" and "xlarge".'
},
{
name: "shape",
type: "string",
default: "square",
name: 'shape',
type: 'string',
default: 'square',
description: 'Shape of the element, valid options are "square" and "circle".'
}
}
];
const AvatarEvents = [
{
name: "error",
description: "Triggered when an error occurs while loading an image file."
name: 'error',
description: 'Triggered when an error occurs while loading an image file.'
}
];
module.exports = {
avatar: {
name: "Avatar",
description: "Avatar represents people using icons, labels and images.",
name: 'Avatar',
description: 'Avatar represents people using icons, labels and images.',
props: AvatarProps,
events: AvatarEvents
}

6
api-generator/components/avatargroup.js
View File

@ -1,7 +1,7 @@
module.exports = {
avatargroup: {
name: "AvatarGroup",
"doc-url": "avatar",
description: "A set of Avatars can be displayed together using the AvatarGroup component."
name: 'AvatarGroup',
'doc-url': 'avatar',
description: 'A set of Avatars can be displayed together using the AvatarGroup component.'
}
};

26
api-generator/components/badge.js
View File

@ -1,28 +1,28 @@
const BadgeProps = [
{
name: "value",
type: "any",
default: "null",
description: "Value to display inside the badge."
name: 'value',
type: 'any',
default: 'null',
description: 'Value to display inside the badge.'
},
{
name: "severity",
type: "string",
default: "null",
description: "Severity type of the badge."
name: 'severity',
type: 'string',
default: 'null',
description: 'Severity type of the badge.'
},
{
name: "size",
type: "string",
default: "null",
name: 'size',
type: 'string',
default: 'null',
description: 'Size of the badge, valid options are "large" and "xlarge".'
}
];
module.exports = {
badge: {
name: "Badge",
description: "Badge is a small status indicator for another element.",
name: 'Badge',
description: 'Badge is a small status indicator for another element.',
props: BadgeProps
}
};

22
api-generator/components/badgedirective.js
View File

@ -1,26 +1,26 @@
const BadgeDirectiveModifiers = [
{
name: "success",
description: "Overrides default severity color"
name: 'success',
description: 'Overrides default severity color'
},
{
name: "info",
description: "Default color for severity levels"
name: 'info',
description: 'Default color for severity levels'
},
{
name: "warning",
description: "Overrides default severity color"
name: 'warning',
description: 'Overrides default severity color'
},
{
name: "danger",
description: "Overrides default severity color"
name: 'danger',
description: 'Overrides default severity color'
}
];
module.exports = {
badgedirective: {
name: "BadgeDirective",
description: "When Badge used as a directive, badge needs to be configured at the application with a name of your choice.",
"vue-modifiers": BadgeDirectiveModifiers
name: 'BadgeDirective',
description: 'When Badge used as a directive, badge needs to be configured at the application with a name of your choice.',
'vue-modifiers': BadgeDirectiveModifiers
}
};

44
api-generator/components/blockui.js
View File

@ -1,45 +1,45 @@
const BlockUIProps = [
{
name: "blocked",
type: "array",
default: "null",
description: "Controls the blocked state."
name: 'blocked',
type: 'array',
default: 'null',
description: 'Controls the blocked state.'
},
{
name: "fullscreen",
type: "menuitem",
default: "null",
description: "When enabled, the whole document gets blocked."
name: 'fullscreen',
type: 'menuitem',
default: 'null',
description: 'When enabled, the whole document gets blocked.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
}
];
const BlockUIEvents = [
{
name: "block",
description: "Fired when the element gets blocked."
name: 'block',
description: 'Fired when the element gets blocked.'
},
{
name: "unblock",
description: "Fired when the element gets unblocked."
name: 'unblock',
description: 'Fired when the element gets unblocked.'
}
];
module.exports = {
blockui: {
name: "BlockUI",
description: "BlockUI can either block other components or the whole page.",
name: 'BlockUI',
description: 'BlockUI can either block other components or the whole page.',
props: BlockUIProps,
events: BlockUIEvents
}

30
api-generator/components/breadcrumb.js
View File

@ -1,35 +1,35 @@
const BreadcrumbProps = [
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "home",
type: "menuitem",
default: "null",
description: "Configuration for the home icon."
name: 'home',
type: 'menuitem',
default: 'null',
description: 'Configuration for the home icon.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const BreadcrumbSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
breadcrumb: {
name: "Breadcrumb",
description: "Breadcrumb provides contextual information about page hierarchy.",
name: 'Breadcrumb',
description: 'Breadcrumb provides contextual information about page hierarchy.',
props: BreadcrumbProps,
slots: BreadcrumbSlots
}

66
api-generator/components/button.js
View File

@ -1,58 +1,58 @@
const ButtonProps = [
{
name: "label",
type: "string",
default: "null",
description: "Text of the button."
name: 'label',
type: 'string',
default: 'null',
description: 'Text of the button.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Name of the icon."
name: 'icon',
type: 'string',
default: 'null',
description: 'Name of the icon.'
},
{
name: "iconPos",
type: "string",
default: "left",
name: 'iconPos',
type: 'string',
default: 'left',
description: 'Position of the icon, valid values are "left", "right", "bottom" and "top".'
},
{
name: "iconClass",
type: "string",
default: "null",
description: "Style class of the icon."
name: 'iconClass',
type: 'string',
default: 'null',
description: 'Style class of the icon.'
},
{
name: "badge",
type: "string",
default: "null",
description: "Value of the badge."
name: 'badge',
type: 'string',
default: 'null',
description: 'Value of the badge.'
},
{
name: "badgeClass",
type: "string",
default: "null",
description: "Style class of the badge."
name: 'badgeClass',
type: 'string',
default: 'null',
description: 'Style class of the badge.'
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Whether the button is in loading state."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Whether the button is in loading state.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner pi-spin",
description: "Icon to display in loading state."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner pi-spin',
description: 'Icon to display in loading state.'
}
];
module.exports = {
button: {
name: "Button",
description: "Button is an extension to standard button element with icons and theming.",
name: 'Button',
description: 'Button is an extension to standard button element with icons and theming.',
props: ButtonProps
}
};

522
api-generator/components/calendar.js
View File

@ -1,420 +1,420 @@
const CalendarProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "selectionMode",
type: "string",
default: "single",
name: 'selectionMode',
type: 'string',
default: 'single',
description: 'Defines the quantity of the selection, valid values are "single", "multiple" and "range".'
},
{
name: "dateFormat",
type: "string",
default: "null",
description: "Format of the date. Defaults to PrimeVue Locale configuration."
name: 'dateFormat',
type: 'string',
default: 'null',
description: 'Format of the date. Defaults to PrimeVue Locale configuration.'
},
{
name: "inline",
type: "boolean",
default: "false",
description: "When enabled, displays the calendar as inline instead of an overlay."
name: 'inline',
type: 'boolean',
default: 'false',
description: 'When enabled, displays the calendar as inline instead of an overlay.'
},
{
name: "showOtherMonths",
type: "boolean",
default: "true",
description: "Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option."
name: 'showOtherMonths',
type: 'boolean',
default: 'true',
description: 'Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option.'
},
{
name: "selectOtherMonths",
type: "boolean",
default: "false",
description: "Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true."
name: 'selectOtherMonths',
type: 'boolean',
default: 'false',
description: 'Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true.'
},
{
name: "showIcon",
type: "boolean",
default: "false",
description: "When enabled, displays a button with icon next to input."
name: 'showIcon',
type: 'boolean',
default: 'false',
description: 'When enabled, displays a button with icon next to input.'
},
{
name: "icon",
type: "string",
default: "pi pi-calendar",
description: "Icon of the calendar button."
name: 'icon',
type: 'string',
default: 'pi pi-calendar',
description: 'Icon of the calendar button.'
},
{
name: "numberOfMonths",
type: "number",
default: "1",
description: "Number of months to display."
name: 'numberOfMonths',
type: 'number',
default: '1',
description: 'Number of months to display.'
},
{
name: "view",
type: "string",
default: "date",
name: 'view',
type: 'string',
default: 'date',
description: 'Type of view to display, valid valids are "date" for datepicker and "month" for month picker.'
},
{
name: "touchUI",
type: "boolean",
default: "false",
description: "When enabled, calendar overlay is displayed as optimized for touch devices."
name: 'touchUI',
type: 'boolean',
default: 'false',
description: 'When enabled, calendar overlay is displayed as optimized for touch devices.'
},
{
name: "monthNavigator",
type: "boolean",
default: "false",
description: "Whether the month should be rendered as a dropdown instead of text."
name: 'monthNavigator',
type: 'boolean',
default: 'false',
description: 'Whether the month should be rendered as a dropdown instead of text.'
},
{
name: "yearNavigator",
type: "boolean",
default: "false",
description: "Whether the year should be rendered as a dropdown instead of text."
name: 'yearNavigator',
type: 'boolean',
default: 'false',
description: 'Whether the year should be rendered as a dropdown instead of text.'
},
{
name: "yearRange",
type: "string",
default: "null",
description: "The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020)."
name: 'yearRange',
type: 'string',
default: 'null',
description: 'The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020).'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the datetimepicker panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the datetimepicker panel.'
},
{
name: "minDate",
type: "Date",
default: "null",
description: "The minimum selectable date."
name: 'minDate',
type: 'Date',
default: 'null',
description: 'The minimum selectable date.'
},
{
name: "maxDate",
type: "Date",
default: "null",
description: "The maximum selectable date."
name: 'maxDate',
type: 'Date',
default: 'null',
description: 'The maximum selectable date.'
},
{
name: "disabledDates",
type: "array",
default: "null",
description: "Array with dates to disable."
name: 'disabledDates',
type: 'array',
default: 'null',
description: 'Array with dates to disable.'
},
{
name: "disabledDays",
type: "array",
default: "null",
description: "Array with disabled weekday numbers."
name: 'disabledDays',
type: 'array',
default: 'null',
description: 'Array with disabled weekday numbers.'
},
{
name: "maxDateCount",
type: "number",
default: "null",
description: "Maximum number of selectable dates in multiple mode."
name: 'maxDateCount',
type: 'number',
default: 'null',
description: 'Maximum number of selectable dates in multiple mode.'
},
{
name: "showOnFocus",
type: "boolean",
default: "true",
description: "When disabled, datepicker will not be visible with input focus."
name: 'showOnFocus',
type: 'boolean',
default: 'true',
description: 'When disabled, datepicker will not be visible with input focus.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "showButtonBar",
type: "boolean",
default: "false",
description: "Whether to display today and clear buttons at the footer"
name: 'showButtonBar',
type: 'boolean',
default: 'false',
description: 'Whether to display today and clear buttons at the footer'
},
{
name: "shortYearCutoff",
type: "string",
default: "+10",
description: "The cutoff year for determining the century for a date."
name: 'shortYearCutoff',
type: 'string',
default: '+10',
description: 'The cutoff year for determining the century for a date.'
},
{
name: "showTime",
type: "boolean",
default: "false",
description: "Whether to display timepicker."
name: 'showTime',
type: 'boolean',
default: 'false',
description: 'Whether to display timepicker.'
},
{
name: "timeOnly",
type: "boolean",
default: "false",
description: "Whether to display timepicker only."
name: 'timeOnly',
type: 'boolean',
default: 'false',
description: 'Whether to display timepicker only.'
},
{
name: "hourFormat",
type: "string",
default: "24",
description: "Specifies 12 or 24 hour format."
name: 'hourFormat',
type: 'string',
default: '24',
description: 'Specifies 12 or 24 hour format.'
},
{
name: "stepHour",
type: "number",
default: "1",
description: "Hours to change per step."
name: 'stepHour',
type: 'number',
default: '1',
description: 'Hours to change per step.'
},
{
name: "stepMinute",
type: "number",
default: "1",
description: "Minutes to change per step."
name: 'stepMinute',
type: 'number',
default: '1',
description: 'Minutes to change per step.'
},
{
name: "stepSeconds",
type: "number",
default: "1",
description: "Seconds to change per step."
name: 'stepSeconds',
type: 'number',
default: '1',
description: 'Seconds to change per step.'
},
{
name: "showSeconds",
type: "boolean",
default: "false",
description: "Whether to show the seconds in time picker."
name: 'showSeconds',
type: 'boolean',
default: 'false',
description: 'Whether to show the seconds in time picker.'
},
{
name: "hideOnDateTimeSelect",
type: "boolean",
default: "false",
description: "Whether to hide the overlay on date selection when showTime is enabled."
name: 'hideOnDateTimeSelect',
type: 'boolean',
default: 'false',
description: 'Whether to hide the overlay on date selection when showTime is enabled.'
},
{
name: "hideOnRangeSelection",
type: "boolean",
default: "false",
description: "Whether to hide the overlay on date selection is completed when selectionMode is range."
name: 'hideOnRangeSelection',
type: 'boolean',
default: 'false',
description: 'Whether to hide the overlay on date selection is completed when selectionMode is range.'
},
{
name: "timeSeparator",
type: "string",
default: ":",
description: "Separator of time selector."
name: 'timeSeparator',
type: 'string',
default: ':',
description: 'Separator of time selector.'
},
{
name: "showWeek",
type: "boolean",
default: "false",
description: "When enabled, calendar will show week numbers."
name: 'showWeek',
type: 'boolean',
default: 'false',
description: 'When enabled, calendar will show week numbers.'
},
{
name: "manualInput",
type: "boolean",
default: "true",
description: "Wheter to allow prevents entering the date manually via typing."
name: 'manualInput',
type: 'boolean',
default: 'true',
description: 'Wheter to allow prevents entering the date manually via typing.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "When present, it specifies that an input field is read-only."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that an input field is read-only.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Placeholder text for the input."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text for the input.'
},
{
name: "id",
type: "string",
default: "null",
description: "Identifier of the element."
name: 'id',
type: 'string',
default: 'null',
description: 'Identifier of the element.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelStyle",
type: "string",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'string',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
}
];
const CalendarEvents = [
{
name: "input",
description: "Callback to invoke when input field is being typed.",
name: 'input',
description: 'Callback to invoke when input field is being typed.',
arguments: [
{
name: "event",
type: "object",
description: "New date"
name: 'event',
type: 'object',
description: 'New date'
}
]
},
{
name: "date-select",
description: "Callback to invoke when a date is selected.",
name: 'date-select',
description: 'Callback to invoke when a date is selected.',
arguments: [
{
name: "value",
type: "Date",
description: "Selected value"
name: 'value',
type: 'Date',
description: 'Selected value'
}
]
},
{
name: "show",
description: "Callback to invoke when datepicker panel is shown."
name: 'show',
description: 'Callback to invoke when datepicker panel is shown.'
},
{
name: "hide",
description: "Callback to invoke when datepicker panel is hidden."
name: 'hide',
description: 'Callback to invoke when datepicker panel is hidden.'
},
{
name: "today-click",
description: "Callback to invoke when today button is clicked.",
name: 'today-click',
description: 'Callback to invoke when today button is clicked.',
arguments: [
{
name: "date",
type: "Date",
description: "Today as a date instance"
name: 'date',
type: 'Date',
description: 'Today as a date instance'
}
]
},
{
name: "clear-click",
description: "Callback to invoke when clear button is clicked.",
name: 'clear-click',
description: 'Callback to invoke when clear button is clicked.',
arguments: [
{
name: "event",
type: "object",
description: "Click event"
name: 'event',
type: 'object',
description: 'Click event'
}
]
},
{
name: "month-change",
description: "Callback to invoke when a month is changed using the navigators.",
name: 'month-change',
description: 'Callback to invoke when a month is changed using the navigators.',
arguments: [
{
name: "event.month",
type: "number",
description: "New month"
name: 'event.month',
type: 'number',
description: 'New month'
},
{
name: "event.year",
type: "number",
description: "New year"
name: 'event.year',
type: 'number',
description: 'New year'
}
]
},
{
name: "year-change",
description: "Callback to invoke when a year is changed using the navigators.",
name: 'year-change',
description: 'Callback to invoke when a year is changed using the navigators.',
arguments: [
{
name: "event.month",
type: "number",
description: "New month"
name: 'event.month',
type: 'number',
description: 'New month'
},
{
name: "event.year",
type: "number",
description: "New year"
name: 'event.year',
type: 'number',
description: 'New year'
}
]
},
{
name: "focus",
description: "Callback to invoke on focus of input field.",
name: 'focus',
description: 'Callback to invoke on focus of input field.',
arguments: [
{
name: "event",
type: "object",
description: "Focus event"
name: 'event',
type: 'object',
description: 'Focus event'
}
]
},
{
name: "blur",
description: "Callback to invoke on blur of input field.",
name: 'blur',
description: 'Callback to invoke on blur of input field.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Input value"
name: 'event.value',
type: 'string',
description: 'Input value'
}
]
},
{
name: "keydown",
description: "Callback to invoke when a key is pressed.",
name: 'keydown',
description: 'Callback to invoke when a key is pressed.',
arguments: [
{
name: "event",
type: "object",
description: "Keydown event"
name: 'event',
type: 'object',
description: 'Keydown event'
}
]
}
@ -422,27 +422,27 @@ const CalendarEvents = [
const CalendarSlots = [
{
name: "header",
description: "Custom content for the component header."
name: 'header',
description: 'Custom content for the component header.'
},
{
name: "footer",
description: "Custom content for the component footer."
name: 'footer',
description: 'Custom content for the component footer.'
},
{
name: "date",
description: "Custom content for the calendar cell."
name: 'date',
description: 'Custom content for the calendar cell.'
},
{
name: "decade",
description: "Custom content for the calendar decade."
name: 'decade',
description: 'Custom content for the calendar decade.'
}
];
module.exports = {
calendar: {
name: "Calendar",
description: "Calendar is an input component to select a date.",
name: 'Calendar',
description: 'Calendar is an input component to select a date.',
props: CalendarProps,
events: CalendarEvents,
slots: CalendarSlots

24
api-generator/components/card.js
View File

@ -1,30 +1,30 @@
const CardSlots = [
{
name: "header",
description: "Custom content for the component header."
name: 'header',
description: 'Custom content for the component header.'
},
{
name: "title",
description: "Custom content for the component title."
name: 'title',
description: 'Custom content for the component title.'
},
{
name: "subtitle",
description: "Custom content for the component subtitle."
name: 'subtitle',
description: 'Custom content for the component subtitle.'
},
{
name: "content",
description: "Custom content for the component content."
name: 'content',
description: 'Custom content for the component content.'
},
{
name: "footer",
description: "Custom content for the component footer."
name: 'footer',
description: 'Custom content for the component footer.'
}
];
module.exports = {
card: {
name: "Card",
description: "Card is a flexible container component.",
name: 'Card',
description: 'Card is a flexible container component.',
slots: CardSlots
}
};

126
api-generator/components/carousel.js
View File

@ -1,109 +1,109 @@
const CarouselProps = [
{
name: "value",
type: "array",
default: "null",
description: "An array of objects to display."
name: 'value',
type: 'array',
default: 'null',
description: 'An array of objects to display.'
},
{
name: "page",
type: "number",
default: "null",
description: "Index of the first item."
name: 'page',
type: 'number',
default: 'null',
description: 'Index of the first item.'
},
{
name: "circular",
type: "boolean",
default: "false",
description: "Defines if scrolling would be infinite."
name: 'circular',
type: 'boolean',
default: 'false',
description: 'Defines if scrolling would be infinite.'
},
{
name: "autoplayInterval",
type: "number",
default: "null",
description: "Time in milliseconds to scroll items automatically."
name: 'autoplayInterval',
type: 'number',
default: 'null',
description: 'Time in milliseconds to scroll items automatically.'
},
{
name: "numVisible",
type: "number",
default: "1",
description: "Number of items per page."
name: 'numVisible',
type: 'number',
default: '1',
description: 'Number of items per page.'
},
{
name: "numScroll",
type: "number",
default: "1",
description: "Number of items to scroll."
name: 'numScroll',
type: 'number',
default: '1',
description: 'Number of items to scroll.'
},
{
name: "responsiveOptions",
type: "any",
default: "null",
description: "An array of options for responsive design."
name: 'responsiveOptions',
type: 'any',
default: 'null',
description: 'An array of options for responsive design.'
},
{
name: "orientation",
type: "string",
default: "horizontal",
name: 'orientation',
type: 'string',
default: 'horizontal',
description: 'Specifies the layout of the component, valid values are "horizontal" and "vertical".'
},
{
name: "verticalViewPortHeight",
type: "string",
default: "300px",
description: "Height of the viewport in vertical layout."
name: 'verticalViewPortHeight',
type: 'string',
default: '300px',
description: 'Height of the viewport in vertical layout.'
},
{
name: "contentClass",
type: "string",
default: "null",
description: "Style class of main content."
name: 'contentClass',
type: 'string',
default: 'null',
description: 'Style class of main content.'
},
{
name: "containerClass",
type: "string",
default: "null",
description: "Style class of the viewport container."
name: 'containerClass',
type: 'string',
default: 'null',
description: 'Style class of the viewport container.'
},
{
name: "indicatorsContentClass",
type: "string",
default: "null",
description: "Style class of the indicator items."
name: 'indicatorsContentClass',
type: 'string',
default: 'null',
description: 'Style class of the indicator items.'
},
{
name: "showNavigators",
type: "boolean",
default: "true",
description: "Whether to display navigation buttons in container."
name: 'showNavigators',
type: 'boolean',
default: 'true',
description: 'Whether to display navigation buttons in container.'
},
{
name: "showIndicators",
type: "boolean",
default: "true",
description: "Whether to display indicator container."
name: 'showIndicators',
type: 'boolean',
default: 'true',
description: 'Whether to display indicator container.'
}
];
const CarouselSlots = [
{
name: "header",
description: "Custom content for the component header."
name: 'header',
description: 'Custom content for the component header.'
},
{
name: "footer",
description: "Custom content for the component footer."
name: 'footer',
description: 'Custom content for the component footer.'
},
{
name: "item",
description: "Custom content for the component item."
name: 'item',
description: 'Custom content for the component item.'
}
];
module.exports = {
carousel: {
name: "Carousel",
description: "Carousel is a content slider featuring various customization options.",
name: 'Carousel',
description: 'Carousel is a content slider featuring various customization options.',
props: CarouselProps,
slots: CarouselSlots
}

318
api-generator/components/cascadeselect.js
View File

@ -1,283 +1,283 @@
const CascadeSelectProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
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: 'options',
type: 'array',
default: 'null',
description: 'An array of selectitems to display as the available options.'
},
{
name: "optionLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option."
name: 'optionLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option.'
},
{
name: "optionValue",
type: "string | function",
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: 'optionValue',
type: 'string | function',
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: '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: "optionGroupLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option group."
name: 'optionGroupLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option group.'
},
{
name: "optionGroupChildren",
type: "array | function",
default: "null",
description: "Property name or getter function to retrieve the items of a group."
name: 'optionGroupChildren',
type: 'array | function',
default: 'null',
description: 'Property name or getter function to retrieve the items of a group.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Default text to display when no option is selected."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Default text to display when no option is selected.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'A property to uniquely identify an option.'
},
{
name: "inputStyle",
type: "object",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'object',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
},
{
name: "panelStyle",
type: "object",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'object',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Whether the multiselect is in loading state."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Whether the multiselect is in loading state.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner pi-spin",
description: "Icon to display in loading state."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner pi-spin',
description: 'Icon to display in loading state.'
},
{
name: "autoOptionFocus",
type: "boolean",
default: "true",
description: "Whether to focus on the first visible or selected element when the overlay panel is shown."
name: 'autoOptionFocus',
type: 'boolean',
default: 'true',
description: 'Whether to focus on the first visible or selected element when the overlay panel is shown.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused option is selected/opened."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused option is selected/opened.'
},
{
name: "searchLocale",
type: "string",
default: "undefined",
name: 'searchLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in searching. The default locale is the host environment's current locale."
},
{
name: "searchMessage",
type: "string",
default: "{0} results are available",
description: "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
name: 'searchMessage',
type: 'string',
default: '{0} results are available',
description: 'Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "selectionMessage",
type: "string",
default: "{0} items selected",
description: "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
name: 'selectionMessage',
type: 'string',
default: '{0} items selected',
description: 'Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySelectionMessage",
type: "string",
default: "No selected item",
description: "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
name: 'emptySelectionMessage',
type: 'string',
default: 'No selected item',
description: 'Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySearchMessage",
type: "string",
default: "No results found",
description: "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
name: 'emptySearchMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
}
];
const CascadeSelectEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Browser event"
name: 'originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "value",
type: "object",
description: "Selected option value"
name: 'value',
type: 'object',
description: 'Selected option value'
}
]
},
{
name: "focus",
description: "Callback to invoke when component receives focus.",
name: 'focus',
description: 'Callback to invoke when component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when component loses focus.",
name: 'blur',
description: 'Callback to invoke when component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "click",
description: "Callback to invoke on click.",
name: 'click',
description: 'Callback to invoke on click.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "group-change",
description: "Callback to invoke when a group changes.",
name: 'group-change',
description: 'Callback to invoke when a group changes.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Browser event"
name: 'originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "value",
type: "object",
description: "Selected option value"
name: 'value',
type: 'object',
description: 'Selected option value'
}
]
},
{
name: "before-show",
description: "Callback to invoke before the overlay is shown."
name: 'before-show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "before-hide",
description: "Callback to invoke before the overlay is hidden."
name: 'before-hide',
description: 'Callback to invoke before the overlay is hidden.'
},
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
}
];
const CascadeSelectSlots = [
{
name: "value",
name: 'value',
description: "Custom content for the item's value"
},
{
name: "option",
name: 'option',
description: "Custom content for the item's option"
},
{
name: "indicator",
description: "Custom content for the dropdown indicator"
name: 'indicator',
description: 'Custom content for the dropdown indicator'
}
];
module.exports = {
cascadeselect: {
name: "CascadeSelect",
description: "CascadeSelect displays a nested structure of options.",
name: 'CascadeSelect',
description: 'CascadeSelect displays a nested structure of options.',
props: CascadeSelectProps,
events: CascadeSelectEvents,
slots: CascadeSelectSlots

96
api-generator/components/chart.js
View File

@ -1,82 +1,82 @@
const ChartProps = [
{
name: "type",
type: "string",
default: "null",
description: "Type of the chart."
name: 'type',
type: 'string',
default: 'null',
description: 'Type of the chart.'
},
{
name: "data",
type: "any",
default: "null",
description: "Data to display."
name: 'data',
type: 'any',
default: 'null',
description: 'Data to display.'
},
{
name: "options",
type: "any",
default: "null",
description: "Options to customize the chart."
name: 'options',
type: 'any',
default: 'null',
description: 'Options to customize the chart.'
},
{
name: "plugins",
type: "any",
default: "null",
description: "Used to custom plugins of the chart."
name: 'plugins',
type: 'any',
default: 'null',
description: 'Used to custom plugins of the chart.'
},
{
name: "width",
type: "number",
default: "300",
description: "Width of the chart in non-responsive mode."
name: 'width',
type: 'number',
default: '300',
description: 'Width of the chart in non-responsive mode.'
},
{
name: "height",
type: "number",
default: "150",
description: "Height of the chart in non-responsive mode."
name: 'height',
type: 'number',
default: '150',
description: 'Height of the chart in non-responsive mode.'
}
];
const ChartEvents = [
{
name: "select",
description: "Callback to invoke when a tab gets expanded.",
name: 'select',
description: 'Callback to invoke when a tab gets expanded.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Browser event"
name: 'originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "dataset",
type: "object",
description: "Selected dataset"
name: 'dataset',
type: 'object',
description: 'Selected dataset'
},
{
name: "element",
type: "object",
description: "Selected element"
name: 'element',
type: 'object',
description: 'Selected element'
},
{
name: "element._datasetIndex",
type: "number",
description: "Index of the dataset in data"
name: 'element._datasetIndex',
type: 'number',
description: 'Index of the dataset in data'
},
{
name: "element._index",
type: "number",
description: "Index of the data in dataset"
name: 'element._index',
type: 'number',
description: 'Index of the data in dataset'
}
]
},
{
name: "loaded",
description: "Callback to invoke when chart is loaded.",
name: 'loaded',
description: 'Callback to invoke when chart is loaded.',
arguments: [
{
name: "chart",
type: "object",
description: "Chart instance."
name: 'chart',
type: 'object',
description: 'Chart instance.'
}
]
}
@ -84,8 +84,8 @@ const ChartEvents = [
module.exports = {
chart: {
name: "Chart",
description: "Chart components are based on Charts.js, an open source HTML5 based charting library.",
name: 'Chart',
description: 'Chart components are based on Charts.js, an open source HTML5 based charting library.',
props: ChartProps,
events: ChartEvents
}

136
api-generator/components/checkbox.js
View File

@ -1,115 +1,115 @@
const CheckboxProps = [
{
name: "value",
type: "any",
default: "null",
description: "Value of the checkbox."
name: 'value',
type: 'any',
default: 'null',
description: 'Value of the checkbox.'
},
{
name: "modelValue",
type: "any",
default: "null",
description: "Value binding of the checkbox."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value binding of the checkbox.'
},
{
name: "binary",
type: "boolean",
default: "false",
description: "Allows to select a boolean value instead of multiple values."
name: 'binary',
type: 'boolean',
default: 'false',
description: 'Allows to select a boolean value instead of multiple values.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "When present, it specifies that an input field is read-only."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that an input field is read-only.'
},
{
name: "required",
type: "boolean",
default: "false",
description: "When present, it specifies that the element is required."
name: 'required',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element is required.'
},
{
name: "tabindex",
type: "number",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
name: "trueValue",
type: "any",
default: "null",
description: "Value in checked state."
name: 'trueValue',
type: 'any',
default: 'null',
description: 'Value in checked state.'
},
{
name: "falseValue",
type: "any",
default: "null",
description: "Value in unchecked state."
name: 'falseValue',
type: 'any',
default: 'null',
description: 'Value in unchecked state.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputClass",
type: "any",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'any',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside 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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const CheckboxEvents = [
{
name: "click",
description: "Callback to invoke on value click.",
name: 'click',
description: 'Callback to invoke on value click.'
},
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.'
},
{
name: "input",
description: "Callback to invoke on value change."
name: 'input',
description: 'Callback to invoke on value change.'
}
];
module.exports = {
checkbox: {
name: "Checkbox",
description: "Checkbox is an extension to standard checkbox element with theming.",
name: 'Checkbox',
description: 'Checkbox is an extension to standard checkbox element with theming.',
props: CheckboxProps,
events: CheckboxEvents
}

54
api-generator/components/chip.js
View File

@ -1,45 +1,45 @@
const ChipProps = [
{
name: "label",
type: "string",
default: "null",
description: "Defines the text to display."
name: 'label',
type: 'string',
default: 'null',
description: 'Defines the text to display.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Defines the icon to display."
name: 'icon',
type: 'string',
default: 'null',
description: 'Defines the icon to display.'
},
{
name: "image",
type: "string",
default: "null",
description: "Defines the image to display."
name: 'image',
type: 'string',
default: 'null',
description: 'Defines the image to display.'
},
{
name: "removable",
type: "boolean",
default: "false",
description: "Whether to display a remove icon."
name: 'removable',
type: 'boolean',
default: 'false',
description: 'Whether to display a remove icon.'
},
{
name: "removeIconClass",
type: "string",
default: "pi pi-times-circle",
description: "Icon of the remove element."
name: 'removeIconClass',
type: 'string',
default: 'pi pi-times-circle',
description: 'Icon of the remove element.'
}
];
const ChipEvents = [
{
name: "remove",
description: "Callback to invoke when a chip is removed.",
name: 'remove',
description: 'Callback to invoke when a chip is removed.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -47,8 +47,8 @@ const ChipEvents = [
module.exports = {
chip: {
name: "Chip",
description: "Chip represents entities using icons, labels and images",
name: 'Chip',
description: 'Chip represents entities using icons, labels and images',
props: ChipProps,
events: ChipEvents
}

126
api-generator/components/chips.js
View File

@ -1,102 +1,102 @@
const ChipsProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'Value of the component.'
},
{
name: "max",
type: "number",
default: "null",
description: "Maximum number of entries allowed."
name: 'max',
type: 'number',
default: 'null',
description: 'Maximum number of entries allowed.'
},
{
name: "separator",
type: "string",
default: "null",
name: 'separator',
type: 'string',
default: 'null',
description: 'Separator char to add an item when pressed in addition to the enter key. Currently only possible value is ","'
},
{
name: "addOnBlur",
type: "boolean",
default: "false",
description: "Whether to add an item when the input loses focus."
name: 'addOnBlur',
type: 'boolean',
default: 'false',
description: 'Whether to add an item when the input loses focus.'
},
{
name: "allowDuplicate",
type: "boolean",
default: "false",
description: "Whether to allow duplicate values or not."
name: 'allowDuplicate',
type: 'boolean',
default: 'false',
description: 'Whether to allow duplicate values or not.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Placeholder text for the input."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text for the input.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the focus input to match a label defined for the chips."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the focus input to match a label defined for the chips.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
}
];
const ChipsEvents = [
{
name: "add",
description: "Callback to invoke when a chip is added.",
name: 'add',
description: 'Callback to invoke when a chip is added.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Browser event"
name: 'originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "value",
type: "array",
description: "Added item value"
name: 'value',
type: 'array',
description: 'Added item value'
}
]
},
{
name: "remove",
description: "Callback to invoke when a chip is removed.",
name: 'remove',
description: 'Callback to invoke when a chip is removed.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Browser event"
name: 'originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "value",
type: "array",
description: "Removed item value"
name: 'value',
type: 'array',
description: 'Removed item value'
}
]
}
@ -104,15 +104,15 @@ const ChipsEvents = [
const ChipsSlots = [
{
name: "chips",
description: "Custom content for the chips"
name: 'chips',
description: 'Custom content for the chips'
}
];
module.exports = {
chips: {
name: "chips",
description: "Chips is used to enter multiple values on an input field.",
name: 'chips',
description: 'Chips is used to enter multiple values on an input field.',
props: ChipsProps,
events: ChipsEvents,
slots: ChipsSlots

120
api-generator/components/colorpicker.js
View File

@ -1,109 +1,109 @@
const ColorPickerProps = [
{
name: "modelValue",
type: "string",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'string',
default: 'null',
description: 'Value of the component.'
},
{
name: "defaultColor",
type: "string",
default: "ff0000",
description: "Initial color to display when value is not defined."
name: 'defaultColor',
type: 'string',
default: 'ff0000',
description: 'Initial color to display when value is not defined.'
},
{
name: "inline",
type: "boolean",
default: "false",
description: "Whether to display as an overlay or not."
name: 'inline',
type: 'boolean',
default: 'false',
description: 'Whether to display as an overlay or not.'
},
{
name: "format",
type: "string",
default: "hex",
name: 'format',
type: 'string',
default: 'hex',
description: 'Format to use in value binding, supported formats are "hex", "rgb" and "hsb".'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "tabindex",
type: "string",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'string',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const ColorPickerEvents = [
{
name: "change",
description: "Callback to invoke when a color is selected.",
name: 'change',
description: 'Callback to invoke when a color is selected.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.value",
type: "any",
description: "Selected color"
name: 'event.value',
type: 'any',
description: 'Selected color'
}
]
},
{
name: "show",
description: "Callback to invoke when popup is shown."
name: 'show',
description: 'Callback to invoke when popup is shown.'
},
{
name: "hide",
description: "Callback to invoke when popup is hidden."
name: 'hide',
description: 'Callback to invoke when popup is hidden.'
}
];
module.exports = {
colorpicker: {
name: "ColorPicker",
description: "ColorPicker is an input component to select a color.",
name: 'ColorPicker',
description: 'ColorPicker is an input component to select a color.',
props: ColorPickerProps,
events: ColorPickerEvents
}

363
api-generator/components/column.js
View File

@ -1,303 +1,302 @@
const ColumnProps = [
{
name: "columnKey",
type: "any",
default: "null",
description: "Identifier of a column if field property is not defined."
name: 'columnKey',
type: 'any',
default: 'null',
description: 'Identifier of a column if field property is not defined.'
},
{
name: "field",
type: "string",
default: "null",
description: "Property represented by the column."
name: 'field',
type: 'string',
default: 'null',
description: 'Property represented by the column.'
},
{
name: "sortField",
type: "string",
default: "null",
description: "Property name to use in sorting, defaults to field."
name: 'sortField',
type: 'string',
default: 'null',
description: 'Property name to use in sorting, defaults to field.'
},
{
name: "filterField",
type: "string",
default: "null",
description: "Property name to use in filtering, defaults to field."
name: 'filterField',
type: 'string',
default: 'null',
description: 'Property name to use in filtering, defaults to field.'
},
{
name: "sortable",
type: "any",
default: "false",
description: "Defines if a column is sortable."
name: 'sortable',
type: 'any',
default: 'false',
description: 'Defines if a column is sortable.'
},
{
name: "header",
type: "any",
default: "null",
description: "Header content of the column."
name: 'header',
type: 'any',
default: 'null',
description: 'Header content of the column.'
},
{
name: "footer",
type: "any",
default: "null",
description: "Footer content of the column."
name: 'footer',
type: 'any',
default: 'null',
description: 'Footer content of the column.'
},
{
name: "style",
type: "object",
default: "null",
description: "Inline style of header, body and footer cells."
name: 'style',
type: 'object',
default: 'null',
description: 'Inline style of header, body and footer cells.'
},
{
name: "class",
type: "string",
default: "null",
description: "Style class of header, body and footer cells."
name: 'class',
type: 'string',
default: 'null',
description: 'Style class of header, body and footer cells.'
},
{
name: "headerStyle",
type: "object",
default: "null",
description: "Inline style of the column header."
name: 'headerStyle',
type: 'object',
default: 'null',
description: 'Inline style of the column header.'
},
{
name: "headerClass",
type: "string",
default: "null",
description: "Style class of the column header."
name: 'headerClass',
type: 'string',
default: 'null',
description: 'Style class of the column header.'
},
{
name: "bodyStyle",
type: "object",
default: "null",
description: "Inline style of the column body."
name: 'bodyStyle',
type: 'object',
default: 'null',
description: 'Inline style of the column body.'
},
{
name: "bodyClass",
type: "string",
default: "null",
description: "Style class of the column body."
name: 'bodyClass',
type: 'string',
default: 'null',
description: 'Style class of the column body.'
},
{
name: "footerStyle",
type: "object",
default: "null",
description: "Inline style of the column footer."
name: 'footerStyle',
type: 'object',
default: 'null',
description: 'Inline style of the column footer.'
},
{
name: "footerClass",
type: "string",
default: "null",
description: "Style class of the footer body."
name: 'footerClass',
type: 'string',
default: 'null',
description: 'Style class of the footer body.'
},
{
name: "showFilterMenu",
type: "boolean",
default: "true",
description: "Whether to display the filter overlay."
name: 'showFilterMenu',
type: 'boolean',
default: 'true',
description: 'Whether to display the filter overlay.'
},
{
name: "showFilterOperator",
type: "boolean",
default: "true",
description: "When enabled, match all and match any operator selector is displayed."
name: 'showFilterOperator',
type: 'boolean',
default: 'true',
description: 'When enabled, match all and match any operator selector is displayed.'
},
{
name: "showClearButton",
type: "boolean",
default: "true",
description: "Displays a button to clear the column filtering."
name: 'showClearButton',
type: 'boolean',
default: 'true',
description: 'Displays a button to clear the column filtering.'
},
{
name: "showApplyButton",
type: "boolean",
default: "true",
description: "Displays a button to apply the column filtering."
name: 'showApplyButton',
type: 'boolean',
default: 'true',
description: 'Displays a button to apply the column filtering.'
},
{
name: "showFilterMatchModes",
type: "boolean",
default: "true",
description: "Whether to show the match modes selector."
name: 'showFilterMatchModes',
type: 'boolean',
default: 'true',
description: 'Whether to show the match modes selector.'
},
{
name: "showAddButton",
type: "boolean",
default: "true",
description: "When enabled, a button is displayed to add more rules."
name: 'showAddButton',
type: 'boolean',
default: 'true',
description: 'When enabled, a button is displayed to add more rules.'
},
{
name: "filterMatchModeOptions",
type: "array",
default: "null",
description: "An array of label-value pairs to override the global match mode options."
name: 'filterMatchModeOptions',
type: 'array',
default: 'null',
description: 'An array of label-value pairs to override the global match mode options.'
},
{
name: "maxConstraints",
type: "number",
default: "2",
description: "Maximum number of constraints for a column filter."
name: 'maxConstraints',
type: 'number',
default: '2',
description: 'Maximum number of constraints for a column filter.'
},
{
name: "excludeGlobalFilter",
type: "boolean",
default: "false",
description: "Whether to exclude from global filtering or not."
name: 'excludeGlobalFilter',
type: 'boolean',
default: 'false',
description: 'Whether to exclude from global filtering or not.'
},
{
name: "filterHeaderStyle",
type: "object",
default: "null",
description: "Inline style of the column filter header in row filter display."
name: 'filterHeaderStyle',
type: 'object',
default: 'null',
description: 'Inline style of the column filter header in row filter display.'
},
{
name: "filterHeaderClass",
type: "string",
default: "null",
description: "Style class of the column filter header in row filter display."
name: 'filterHeaderClass',
type: 'string',
default: 'null',
description: 'Style class of the column filter header in row filter display.'
},
{
name: "filterMenuStyle",
type: "object",
default: "null",
description: "Inline style of the column filter overlay."
name: 'filterMenuStyle',
type: 'object',
default: 'null',
description: 'Inline style of the column filter overlay.'
},
{
name: "filterMenuClass",
type: "string",
default: "null",
description: "Style class of the column filter overlay."
name: 'filterMenuClass',
type: 'string',
default: 'null',
description: 'Style class of the column filter overlay.'
},
{
name: "selectionMode",
type: "string",
default: "null",
name: 'selectionMode',
type: 'string',
default: 'null',
description: 'Defines column based selection mode, options are "single" and "multiple".'
},
{
name: "expander",
type: "boolean",
default: "false",
description: "Displays an icon to toggle row expansion."
name: 'expander',
type: 'boolean',
default: 'false',
description: 'Displays an icon to toggle row expansion.'
},
{
name: "colspan",
type: "number",
default: "null",
description: "Number of columns to span for grouping."
name: 'colspan',
type: 'number',
default: 'null',
description: 'Number of columns to span for grouping.'
},
{
name: "rowspan",
type: "number",
default: "null",
description: "Number of rows to span for grouping."
name: 'rowspan',
type: 'number',
default: 'null',
description: 'Number of rows to span for grouping.'
},
{
name: "rowReorder",
type: "boolean",
default: "false",
description: "Whether this column displays an icon to reorder the rows."
name: 'rowReorder',
type: 'boolean',
default: 'false',
description: 'Whether this column displays an icon to reorder the rows.'
},
{
name: "rowReorderIcon",
type: "string",
default: "pi pi-bars",
description: "Icon of the drag handle to reorder rows."
name: 'rowReorderIcon',
type: 'string',
default: 'pi pi-bars',
description: 'Icon of the drag handle to reorder rows.'
},
{
name: "reorderableColumn",
type: "boolean",
default: "true",
description: "Defines if the column itself can be reordered with dragging."
name: 'reorderableColumn',
type: 'boolean',
default: 'true',
description: 'Defines if the column itself can be reordered with dragging.'
},
{
name: "rowEditor",
type: "boolean",
default: "false",
description: "When enabled, column displays row editor controls."
name: 'rowEditor',
type: 'boolean',
default: 'false',
description: 'When enabled, column displays row editor controls.'
},
{
name: "frozen",
type: "boolean",
default: "false",
description: "Whether the column is fixed in horizontal scrolling."
name: 'frozen',
type: 'boolean',
default: 'false',
description: 'Whether the column is fixed in horizontal scrolling.'
},
{
name: "alignFrozen",
type: "string",
default: "left",
description: "Position of a frozen column, valid values are left and right."
name: 'alignFrozen',
type: 'string',
default: 'left',
description: 'Position of a frozen column, valid values are left and right.'
},
{
name: "exportable",
type: "boolean",
default: "true",
description: "Whether the column is included in data export."
name: 'exportable',
type: 'boolean',
default: 'true',
description: 'Whether the column is included in data export.'
},
{
name: "exportHeader",
type: "string",
default: "null",
description: "Custom export header of the column to be exported as CSV."
name: 'exportHeader',
type: 'string',
default: 'null',
description: 'Custom export header of the column to be exported as CSV.'
},
{
name: "exportFooter",
type: "string",
default: "null",
description: "Custom export footer of the column to be exported as CSV."
name: 'exportFooter',
type: 'string',
default: 'null',
description: 'Custom export footer of the column to be exported as CSV.'
},
{
name: "hidden",
type: "boolean",
default: "false",
description: "Whether the column is rendered."
name: 'hidden',
type: 'boolean',
default: 'false',
description: 'Whether the column is rendered.'
}
];
const ColumnSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "body",
name: 'body',
description: "Custom content for the component's body"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
},
{
name: "editor",
description: "Custom content for the editing cell"
name: 'editor',
description: 'Custom content for the editing cell'
},
{
name: "filter",
description: "Custom content for the filtering items"
name: 'filter',
description: 'Custom content for the filtering items'
},
{
name: "filterheader",
name: 'filterheader',
description: "Custom content for the filter menu's header"
},
{
name: "filterfooter",
name: 'filterfooter',
description: "Custom content for the filter menu's footer"
},
{
name: "filterclear",
name: 'filterclear',
description: "Custom content for the filter menu's clear section"
},
{
name: "filterapply",
name: 'filterapply',
description: "Custom content for the filter menu's apply section"
}
];
module.exports = {
column: {
name: "Column",
description: "DataTable requires a value as an array of objects and columns defined with Column component.",
"doc-url": "datatable",
name: 'Column',
description: 'DataTable requires a value as an array of objects and columns defined with Column component.',
'doc-url': 'datatable',
props: ColumnProps,
slots: ColumnSlots
}

6
api-generator/components/columngroup.js
View File

@ -1,7 +1,7 @@
module.exports = {
columngroup: {
name: "ColumnGroup",
description: "Columns can be grouped at header and footer sections by defining a ColumnGroup with nested rows and columns",
"doc-url": "datatable"
name: 'ColumnGroup',
description: 'Columns can be grouped at header and footer sections by defining a ColumnGroup with nested rows and columns',
'doc-url': 'datatable'
}
};

24
api-generator/components/confirmdialog.js
View File

@ -1,29 +1,29 @@
const ConfirmDialogProps = [
{
name: "group",
type: "string",
default: "null",
description: "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance."
name: 'group',
type: 'string',
default: 'null',
description: 'Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.'
},
{
name: "breakpoints",
type: "object",
default: "null",
description: "Object literal to define widths per screen size."
name: 'breakpoints',
type: 'object',
default: 'null',
description: 'Object literal to define widths per screen size.'
}
];
const ConfirmDialogSlots = [
{
name: "message",
description: "Custom content for the component."
name: 'message',
description: 'Custom content for the component.'
}
];
module.exports = {
confirmdialog: {
name: "ConfirmDialog",
description: "ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.",
name: 'ConfirmDialog',
description: 'ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.',
props: ConfirmDialogProps,
slots: ConfirmDialogSlots
}

16
api-generator/components/confirmpopup.js
View File

@ -1,23 +1,23 @@
const ConfirmPopupProps = [
{
name: "group",
type: "string",
default: "null",
description: "Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance."
name: 'group',
type: 'string',
default: 'null',
description: 'Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.'
}
];
const ConfirmPopupSlots = [
{
name: "message",
description: "Custom content for the component."
name: 'message',
description: 'Custom content for the component.'
}
];
module.exports = {
confirmpopup: {
name: "ConfirmPopup",
description: "ConfirmPopup displays a confirmation overlay displayed relatively to its target.",
name: 'ConfirmPopup',
description: 'ConfirmPopup displays a confirmation overlay displayed relatively to its target.',
props: ConfirmPopupProps,
slots: ConfirmPopupSlots
}

54
api-generator/components/contextmenu.js
View File

@ -1,53 +1,53 @@
const ContextMenuProps = [
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "global",
type: "boolean",
default: "false",
description: "Attaches the menu to document instead of a particular item."
name: 'global',
type: 'boolean',
default: 'false',
description: 'Attaches the menu to document instead of a particular item.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const ContextMenuSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
contextmenu: {
name: "ContextMenu",
description: "ContextMenu displays an overlay menu on right click of its target.",
name: 'ContextMenu',
description: 'ContextMenu displays an overlay menu on right click of its target.',
props: ContextMenuProps,
slots: ContextMenuSlots
}

1304
api-generator/components/datatable.js
View File

File diff suppressed because it is too large Load Diff

176
api-generator/components/dataview.js
View File

@ -1,126 +1,126 @@
const DataViewProps = [
{
name: "value",
type: "array",
default: "null",
description: "An array of objects to display."
name: 'value',
type: 'array',
default: 'null',
description: 'An array of objects to display.'
},
{
name: "layout",
type: "string",
default: "list",
name: 'layout',
type: 'string',
default: 'list',
description: 'Layout of the items, valid values are "list" and "grid".'
},
{
name: "rows",
type: "number",
default: "0",
description: "Number of rows to display per page."
name: 'rows',
type: 'number',
default: '0',
description: 'Number of rows to display per page.'
},
{
name: "first",
type: "number",
default: "0",
description: "ndex of the first record to render."
name: 'first',
type: 'number',
default: '0',
description: 'ndex of the first record to render.'
},
{
name: "totalRecords",
type: "number",
default: "null",
description: "Number of total records, defaults to length of value when not defined."
name: 'totalRecords',
type: 'number',
default: 'null',
description: 'Number of total records, defaults to length of value when not defined.'
},
{
name: "paginator",
type: "boolean",
default: "false",
description: "When specified as true, enables the pagination."
name: 'paginator',
type: 'boolean',
default: 'false',
description: 'When specified as true, enables the pagination.'
},
{
name: "paginatorPosition",
type: "string",
default: "bottom",
name: 'paginatorPosition',
type: 'string',
default: 'bottom',
description: 'Position of the paginator, options are "top","bottom" or "both".'
},
{
name: "alwaysShowPaginator",
type: "boolean",
default: "true",
description: "Whether to show it even there is only one page."
name: 'alwaysShowPaginator',
type: 'boolean',
default: 'true',
description: 'Whether to show it even there is only one page.'
},
{
name: "paginatorTemplate",
type: "string",
default: "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown",
description: "Template of the paginator."
name: 'paginatorTemplate',
type: 'string',
default: 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown',
description: 'Template of the paginator.'
},
{
name: "pageLinkSize",
type: "number",
default: "5",
description: "Number of page links to display."
name: 'pageLinkSize',
type: 'number',
default: '5',
description: 'Number of page links to display.'
},
{
name: "rowsPerPageOptions",
type: "array",
default: "null",
description: "Array of integer values to display inside rows per page dropdown."
name: 'rowsPerPageOptions',
type: 'array',
default: 'null',
description: 'Array of integer values to display inside rows per page dropdown.'
},
{
name: "currentPageReportTemplate",
type: "string",
default: "({currentPage} of {totalPages})",
description: "Template of the current page report element."
name: 'currentPageReportTemplate',
type: 'string',
default: '({currentPage} of {totalPages})',
description: 'Template of the current page report element.'
},
{
name: "sortField",
type: "string",
default: "null",
description: "Property name or a getter function of data to use in sorting by default."
name: 'sortField',
type: 'string',
default: 'null',
description: 'Property name or a getter function of data to use in sorting by default.'
},
{
name: "sortOrder",
type: "number",
default: "null",
description: "Order to sort the data by default."
name: 'sortOrder',
type: 'number',
default: 'null',
description: 'Order to sort the data by default.'
},
{
name: "lazy",
type: "boolean",
default: "false",
description: "Defines if data is loaded and interacted with in lazy manner."
name: 'lazy',
type: 'boolean',
default: 'false',
description: 'Defines if data is loaded and interacted with in lazy manner.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "Name of the data that uniquely identifies the a record in the data."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'Name of the data that uniquely identifies the a record in the data.'
}
];
const DataViewEvents = [
{
name: "page",
description: "Callback to invoke when page changes, the event object contains information about the new state.",
name: 'page',
description: 'Callback to invoke when page changes, the event object contains information about the new state.',
arguments: [
{
name: "event.page",
type: "number",
description: "New page number"
name: 'event.page',
type: 'number',
description: 'New page number'
},
{
name: "event.first",
type: "number",
description: "Index of first record"
name: 'event.first',
type: 'number',
description: 'Index of first record'
},
{
name: "event.rows",
type: "number",
description: "Number of rows to display in new page"
name: 'event.rows',
type: 'number',
description: 'Number of rows to display in new page'
},
{
name: "event.pageCount",
type: "number",
description: "Total number of pages"
name: 'event.pageCount',
type: 'number',
description: 'Total number of pages'
}
]
}
@ -128,39 +128,39 @@ const DataViewEvents = [
const DataViewSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "paginatorstart",
name: 'paginatorstart',
description: "Custom content for the component paginator's left side"
},
{
name: "paginatorend",
name: 'paginatorend',
description: "Custom content for the component paginator's right side"
},
{
name: "list",
description: "Content for the list layout"
name: 'list',
description: 'Content for the list layout'
},
{
name: "grid",
description: "Content for the grid layout"
name: 'grid',
description: 'Content for the grid layout'
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
}
];
module.exports = {
dataview: {
name: "DataView",
description: "DataView displays data in grid or list layout with pagination and sorting features.",
name: 'DataView',
description: 'DataView displays data in grid or list layout with pagination and sorting features.',
props: DataViewProps,
events: DataViewEvents,
slots: DataViewSlots

6
api-generator/components/dataviewlayoutoptions.js
View File

@ -1,7 +1,7 @@
module.exports = {
dataviewlayoutoptions: {
name: "DataViewLayoutOptions",
description: "When both layout modes are enabled in DataView, a UI element would be necessary to let the user toggle between the view. DataViewLayoutOptions is a helper component to display a buttonset to choose the layout mode in DataView.",
"doc-url": "dataview"
name: 'DataViewLayoutOptions',
description: 'When both layout modes are enabled in DataView, a UI element would be necessary to let the user toggle between the view. DataViewLayoutOptions is a helper component to display a buttonset to choose the layout mode in DataView.',
'doc-url': 'dataview'
}
};

14
api-generator/components/deferredcontent.js
View File

@ -1,12 +1,12 @@
const DeferredContentEvents = [
{
name: "load",
description: "Callback to invoke when deferred content is loaded..",
name: 'load',
description: 'Callback to invoke when deferred content is loaded..',
arguments: [
{
name: "event",
type: "object",
description: "Event object"
name: 'event',
type: 'object',
description: 'Event object'
}
]
}
@ -14,8 +14,8 @@ const DeferredContentEvents = [
module.exports = {
deferredcontent: {
name: "DeferredContent",
description: "DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.",
name: 'DeferredContent',
description: 'DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.',
events: DeferredContentEvents
}
};

222
api-generator/components/dialog.js
View File

@ -1,181 +1,181 @@
const DialogProps = [
{
name: "header",
type: "any",
default: "null",
description: "Title content of the dialog."
name: 'header',
type: 'any',
default: 'null',
description: 'Title content of the dialog.'
},
{
name: "footer",
type: "any",
default: "null",
description: "Footer content of the dialog."
name: 'footer',
type: 'any',
default: 'null',
description: 'Footer content of the dialog.'
},
{
name: "visible",
type: "boolean",
default: "false",
description: "Specifies the visibility of the dialog."
name: 'visible',
type: 'boolean',
default: 'false',
description: 'Specifies the visibility of the dialog.'
},
{
name: "modal",
type: "boolean",
default: "null",
description: "Defines if background should be blocked when dialog is displayed."
name: 'modal',
type: 'boolean',
default: 'null',
description: 'Defines if background should be blocked when dialog is displayed.'
},
{
name: "closeOnEscape",
type: "boolean",
default: "true",
description: "Specifies if pressing escape key should hide the dialog."
name: 'closeOnEscape',
type: 'boolean',
default: 'true',
description: 'Specifies if pressing escape key should hide the dialog.'
},
{
name: "dismissableMask",
type: "boolean",
default: "false",
description: "Specifies if clicking the modal background should hide the dialog."
name: 'dismissableMask',
type: 'boolean',
default: 'false',
description: 'Specifies if clicking the modal background should hide the dialog.'
},
{
name: "position",
type: "string",
default: "center",
name: 'position',
type: 'string',
default: 'center',
description: 'Position of the dialog, options are "center", "top", "bottom", "left", "right", "topleft", "topright", "bottomleft" or "bottomright".'
},
{
name: "contentStyle",
type: "object",
default: "null",
description: "Style of the content section."
name: 'contentStyle',
type: 'object',
default: 'null',
description: 'Style of the content section.'
},
{
name: "contentClass",
type: "string",
default: "null",
description: "Style class of the content section."
name: 'contentClass',
type: 'string',
default: 'null',
description: 'Style class of the content section.'
},
{
name: "rtl",
type: "boolean",
default: "null",
description: "When enabled dialog is displayed in RTL direction."
name: 'rtl',
type: 'boolean',
default: 'null',
description: 'When enabled dialog is displayed in RTL direction.'
},
{
name: "closable",
type: "boolean",
default: "true",
description: "Adds a close icon to the header to hide the dialog."
name: 'closable',
type: 'boolean',
default: 'true',
description: 'Adds a close icon to the header to hide the dialog.'
},
{
name: "showHeader",
type: "boolean",
default: "true",
description: "Whether to show the header or not."
name: 'showHeader',
type: 'boolean',
default: 'true',
description: 'Whether to show the header or not.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "ariaCloseLabel",
type: "string",
default: "close",
description: "Aria label of the close icon."
name: 'ariaCloseLabel',
type: 'string',
default: 'close',
description: 'Aria label of the close icon.'
},
{
name: "maximizable",
type: "boolean",
default: "false",
description: "Whether the dialog can be displayed full screen."
name: 'maximizable',
type: 'boolean',
default: 'false',
description: 'Whether the dialog can be displayed full screen.'
},
{
name: "breakpoints",
type: "object",
default: "null",
description: "Object literal to define widths per screen size."
name: 'breakpoints',
type: 'object',
default: 'null',
description: 'Object literal to define widths per screen size.'
},
{
name: "draggable",
type: "boolean",
default: "true",
description: "Whether the dialog can be relocated by dragging."
name: 'draggable',
type: 'boolean',
default: 'true',
description: 'Whether the dialog can be relocated by dragging.'
},
{
name: "minX",
type: "number",
default: "0",
description: "Minimum value for the left coordinate of dialog in dragging."
name: 'minX',
type: 'number',
default: '0',
description: 'Minimum value for the left coordinate of dialog in dragging.'
},
{
name: "minY",
type: "number",
default: "0",
description: "Minimum value for the top coordinate of dialog in dragging."
name: 'minY',
type: 'number',
default: '0',
description: 'Minimum value for the top coordinate of dialog in dragging.'
},
{
name: "keepInViewport",
type: "boolean",
default: "true",
description: "Keeps dialog in the viewport when dragging."
name: 'keepInViewport',
type: 'boolean',
default: 'true',
description: 'Keeps dialog in the viewport when dragging.'
},
{
name: "appendTo",
type: "string",
default: "body",
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the dialog gets attached. Special keywords are "body" for document body and "self" for the element itself.'
}
];
const DialogEvents = [
{
name: "hide",
description: "Callback to invoke when dialog is hidden."
name: 'hide',
description: 'Callback to invoke when dialog is hidden.'
},
{
name: "after-hide",
description: "Callback to invoke after dialog is hidden."
name: 'after-hide',
description: 'Callback to invoke after dialog is hidden.'
},
{
name: "show",
description: "Callback to invoke when dialog is showed."
name: 'show',
description: 'Callback to invoke when dialog is showed.'
},
{
name: "maximize",
description: "Fired when a dialog gets maximized.",
name: 'maximize',
description: 'Fired when a dialog gets maximized.',
arguments: [
{
name: "event",
type: "object",
description: "Event Object"
name: 'event',
type: 'object',
description: 'Event Object'
}
]
},
{
name: "unmaximize",
description: "Fired when a dialog gets unmaximized.",
name: 'unmaximize',
description: 'Fired when a dialog gets unmaximized.',
arguments: [
{
name: "event",
type: "object",
description: "Event Object"
name: 'event',
type: 'object',
description: 'Event Object'
}
]
},
{
name: "dragend",
description: "Fired when a dialog drag completes.",
name: 'dragend',
description: 'Fired when a dialog drag completes.',
arguments: [
{
name: "event",
type: "object",
description: "Event Object"
name: 'event',
type: 'object',
description: 'Event Object'
}
]
}
@ -183,19 +183,19 @@ const DialogEvents = [
const DialogSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
}
];
module.exports = {
dialog: {
name: "Dialog",
description: "Dialog is a container to display content in an overlay window.",
name: 'Dialog',
description: 'Dialog is a container to display content in an overlay window.',
props: DialogProps,
events: DialogEvents,
slots: DialogSlots

22
api-generator/components/divider.js
View File

@ -1,28 +1,28 @@
const DividerProps = [
{
name: "align",
type: "string",
default: "null",
name: 'align',
type: 'string',
default: 'null',
description: 'Alignment of the content, options are "left", "center", "right" for horizontal layout and "top", "center", "bottom" for vertical.'
},
{
name: "layout",
type: "string",
default: "horizontal",
name: 'layout',
type: 'string',
default: 'horizontal',
description: 'Specifies the orientation, valid values are "horizontal" and "vertical".'
},
{
name: "type",
type: "string",
default: "solid",
name: 'type',
type: 'string',
default: 'solid',
description: 'Border style type, default is "solid" and other options are "dashed" and "dotted".'
}
];
module.exports = {
divider: {
name: "Divider",
description: "Divider is used to separate contents.",
name: 'Divider',
description: 'Divider is used to separate contents.',
props: DividerProps
}
};

56
api-generator/components/dock.js
View File

@ -1,58 +1,58 @@
const DockProps = [
{
name: "model",
type: "object",
default: "null",
description: "MenuModel instance to define the action items."
name: 'model',
type: 'object',
default: 'null',
description: 'MenuModel instance to define the action items.'
},
{
name: "position",
type: "string",
default: "bottom",
name: 'position',
type: 'string',
default: 'bottom',
description: "Position of element. Valid values are 'bottom', 'top', 'left' and 'right'."
},
{
name: "class",
type: "string",
default: "null",
description: "Style class of the element."
name: 'class',
type: 'string',
default: 'null',
description: 'Style class of the element.'
},
{
name: "style",
type: "object",
default: "null",
description: "Inline style of the element."
name: 'style',
type: 'object',
default: 'null',
description: 'Inline style of the element.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
},
{
name: "tooltipOptions",
type: "object",
default: "null",
name: 'tooltipOptions',
type: 'object',
default: 'null',
description: "Whether to display the tooltip on items. The modifiers of tooltip can be used like an object in it. Valid keys are 'event' and 'position'."
}
];
const DockSlots = [
{
name: "item",
description: "Custom content for the item."
name: 'item',
description: 'Custom content for the item.'
},
{
name: "icon",
description: "Custom content for the icon."
name: 'icon',
description: 'Custom content for the icon.'
}
];
module.exports = {
dock: {
name: "Dock",
description: "Dock is a navigation component consisting of menuitems.",
name: 'Dock',
description: 'Dock is a navigation component consisting of menuitems.',
props: DockProps,
slots: DockSlots
}
}
};

440
api-generator/components/dropdown.js
View File

@ -1,332 +1,332 @@
const DropdownProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
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: 'options',
type: 'array',
default: 'null',
description: 'An array of selectitems to display as the available options.'
},
{
name: "optionLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option."
name: 'optionLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option.'
},
{
name: "optionValue",
type: "string | function",
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: 'optionValue',
type: 'string | function',
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: '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: "optionGroupLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option group."
name: 'optionGroupLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option group.'
},
{
name: "optionGroupChildren",
type: "string | function",
default: "null",
description: "Property name or getter function that refers to the children options of option group."
name: 'optionGroupChildren',
type: 'string | function',
default: 'null',
description: 'Property name or getter function that refers to the children options of option group.'
},
{
name: "scrollHeight",
type: "string",
default: "200px",
description: "Height of the viewport, a scrollbar is defined if height of list exceeds this value."
name: 'scrollHeight',
type: 'string',
default: '200px',
description: 'Height of the viewport, a scrollbar is defined if height of list exceeds this value.'
},
{
name: "filter",
type: "boolean",
default: "false",
description: "When specified, displays a filter input at header."
name: 'filter',
type: 'boolean',
default: 'false',
description: 'When specified, displays a filter input at header.'
},
{
name: "filterPlaceholder",
type: "string",
default: "null",
description: "Placeholder text to show when filter input is empty."
name: 'filterPlaceholder',
type: 'string',
default: 'null',
description: 'Placeholder text to show when filter input is empty.'
},
{
name: "filterLocale",
type: "string",
default: "undefined",
name: 'filterLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in filtering. The default locale is the host environment's current locale."
},
{
name: "filterMatchMode",
type: "string",
default: "contains",
name: 'filterMatchMode',
type: 'string',
default: 'contains',
description: 'Defines the filtering algorithm to use when searching the options. Valid values are "contains" (default), "startsWith" and "endsWith"'
},
{
name: "filterFields",
type: "array",
default: "null",
description: "Fields used when filtering the options, defaults to optionLabel."
name: 'filterFields',
type: 'array',
default: 'null',
description: 'Fields used when filtering the options, defaults to optionLabel.'
},
{
name: "editable",
type: "boolean",
default: "false",
description: "When present, custom value instead of predefined options can be entered using the editable input field."
name: 'editable',
type: 'boolean',
default: 'false',
description: 'When present, custom value instead of predefined options can be entered using the editable input field.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Default text to display when no option is selected."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Default text to display when no option is selected.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'A property to uniquely identify an option.'
},
{
name: "showClear",
type: "boolean",
default: "false",
description: "When enabled, a clear icon is displayed to clear the value."
name: 'showClear',
type: 'boolean',
default: 'false',
description: 'When enabled, a clear icon is displayed to clear the value.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "object",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'object',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
},
{
name: "panelStyle",
type: "object",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'object',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
},
{
name: "filterInputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the filter input inside the component."
name: 'filterInputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the filter input inside the component.'
},
{
name: "clearIconProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLElement to the clear icon inside the component."
name: 'clearIconProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLElement to the clear icon inside the component.'
},
{
name: "appendTo",
type: "string",
default: "body",
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."
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Whether the multiselect is in loading state."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Whether the multiselect is in loading state.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner pi-spin",
description: "Icon to display in loading state."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner pi-spin',
description: 'Icon to display in loading state.'
},
{
name: "resetFilterOnHide",
type: "boolean",
default: "false",
description: "Clears the filter value when hiding the dropdown."
name: 'resetFilterOnHide',
type: 'boolean',
default: 'false',
description: 'Clears the filter value when hiding the dropdown.'
},
{
name: "virtualScrollerOptions",
type: "object",
default: "null",
description: "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it."
name: 'virtualScrollerOptions',
type: 'object',
default: 'null',
description: 'Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.'
},
{
name: "autoOptionFocus",
type: "boolean",
default: "true",
description: "Whether to focus on the first visible or selected element when the overlay panel is shown."
name: 'autoOptionFocus',
type: 'boolean',
default: 'true',
description: 'Whether to focus on the first visible or selected element when the overlay panel is shown.'
},
{
name: "autoFilterFocus",
type: "boolean",
default: "false",
description: "Whether to focus on the filter element when the overlay panel is shown."
name: 'autoFilterFocus',
type: 'boolean',
default: 'false',
description: 'Whether to focus on the filter element when the overlay panel is shown.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused option is selected."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused option is selected.'
},
{
name: "filterMessage",
type: "string",
default: "{0} results are available",
description: "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
name: 'filterMessage',
type: 'string',
default: '{0} results are available',
description: 'Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "selectionMessage",
type: "string",
default: "{0} items selected",
description: "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
name: 'selectionMessage',
type: 'string',
default: '{0} items selected',
description: 'Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySelectionMessage",
type: "string",
default: "No selected item",
description: "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
name: 'emptySelectionMessage',
type: 'string',
default: 'No selected item',
description: 'Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyFilterMessage",
type: "string",
default: "No results found",
description: "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
name: 'emptyFilterMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyMessage",
type: "string",
default: "No results found",
description: "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
name: 'emptyMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
}
];
const DropdownEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Selected option value"
name: 'event.value',
type: 'string',
description: 'Selected option value'
}
]
},
{
name: "focus",
description: "Callback to invoke when component receives focus.",
name: 'focus',
description: 'Callback to invoke when component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when component loses focus.",
name: 'blur',
description: 'Callback to invoke when component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "before-show",
description: "Callback to invoke before the overlay is shown."
name: 'before-show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "before-hide",
description: "Callback to invoke before the overlay is hidden."
name: 'before-hide',
description: 'Callback to invoke before the overlay is hidden.'
},
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
},
{
name: "filter",
description: "Callback to invoke when the overlay is shown.",
name: 'filter',
description: 'Callback to invoke when the overlay is shown.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Filter value"
name: 'event.value',
type: 'string',
description: 'Filter value'
}
]
}
@ -334,51 +334,51 @@ const DropdownEvents = [
const DropdownSlots = [
{
name: "value",
name: 'value',
description: "Custom content for the item's value"
},
{
name: "indicator",
description: "Custom content for the dropdown indicator"
name: 'indicator',
description: 'Custom content for the dropdown indicator'
},
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
},
{
name: "option",
name: 'option',
description: "Custom content for the item's option"
},
{
name: "optiongroup",
name: 'optiongroup',
description: "Custom content for the item's optiongroup"
},
{
name: "emptyfilter",
description: "Custom content when there is no filtered data to display"
name: 'emptyfilter',
description: 'Custom content when there is no filtered data to display'
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "content",
description: "Custom content for the virtual scroller"
name: 'content',
description: 'Custom content for the virtual scroller'
},
{
name: "loader",
description: "Custom content for the virtual scroller loader items"
name: 'loader',
description: 'Custom content for the virtual scroller loader items'
}
];
module.exports = {
dropdown: {
name: "Dropdown",
description: "Dropdown is used to select an item from a list of options.",
name: 'Dropdown',
description: 'Dropdown is used to select an item from a list of options.',
props: DropdownProps,
events: DropdownEvents,
slots: DropdownSlots

4
api-generator/components/dynamicdialog.js
View File

@ -6,8 +6,8 @@ const DynamicDialogSlots = [];
module.exports = {
dynamicdialog: {
name: "DynamicDialog",
description: "Dialogs can be created dynamically with any component as the content using a DialogService.",
name: 'DynamicDialog',
description: 'Dialogs can be created dynamically with any component as the content using a DialogService.',
props: DynamicDialogProps,
events: DynamicDialogEvents,
slots: DynamicDialogSlots

114
api-generator/components/editor.js
View File

@ -1,33 +1,33 @@
const EditorProps = [
{
name: "modelValue",
type: "string",
default: "null",
description: "Value of the content."
name: 'modelValue',
type: 'string',
default: 'null',
description: 'Value of the content.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Placeholder text to show when editor is empty."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text to show when editor is empty.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "Whether to instantiate the editor to readonly mode."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'Whether to instantiate the editor to readonly mode.'
},
{
name: "formats",
type: "string[]",
default: "null",
description: "Whitelist of formats to display."
name: 'formats',
type: 'string[]',
default: 'null',
description: 'Whitelist of formats to display.'
},
{
name: "editorStyle",
type: "any",
default: "null",
description: "Inline style of the container."
name: 'editorStyle',
type: 'any',
default: 'null',
description: 'Inline style of the container.'
},
{
name: 'modules',
@ -39,69 +39,69 @@ const EditorProps = [
const EditorEvents = [
{
name: "text-change",
description: "Callback to invoke when text of editor changes.",
name: 'text-change',
description: 'Callback to invoke when text of editor changes.',
arguments: [
{
name: "event.delta",
type: "object",
description: "Representation of the change."
name: 'event.delta',
type: 'object',
description: 'Representation of the change.'
},
{
name: "event.source",
type: "string",
name: 'event.source',
type: 'string',
description: 'Source of change. Will be either "user" or "api".'
},
{
name: "event.htmlValue",
type: "string",
description: "Current value as html."
name: 'event.htmlValue',
type: 'string',
description: 'Current value as html.'
},
{
name: "event.textValue",
type: "string",
description: "Current value as text."
name: 'event.textValue',
type: 'string',
description: 'Current value as text.'
},
{
name: "event.instance",
type: "object",
description: "Text editor instance."
name: 'event.instance',
type: 'object',
description: 'Text editor instance.'
}
]
},
{
name: "selection-change",
description: "Callback to invoke when selection of the text changes.",
name: 'selection-change',
description: 'Callback to invoke when selection of the text changes.',
arguments: [
{
name: "event.range",
type: "object",
description: "Representation of the selection boundaries."
name: 'event.range',
type: 'object',
description: 'Representation of the selection boundaries.'
},
{
name: "event.oldRange",
type: "string",
name: 'event.oldRange',
type: 'string',
description: 'Representation of the previous selection boundaries.'
},
{
name: "event.source",
type: "string",
name: 'event.source',
type: 'string',
description: 'Source of change. Will be either "user" or "api".'
},
{
name: "event.htmlValue",
type: "string",
description: "Current value as html."
name: 'event.htmlValue',
type: 'string',
description: 'Current value as html.'
},
{
name: "event.textValue",
type: "string",
description: "Current value as text."
name: 'event.textValue',
type: 'string',
description: 'Current value as text.'
},
{
name: "event.instance",
type: "object",
description: "Text editor instance."
name: 'event.instance',
type: 'object',
description: 'Text editor instance.'
}
]
},
@ -120,15 +120,15 @@ const EditorEvents = [
const EditorSlots = [
{
name: "toolbar",
name: 'toolbar',
description: "Custom content for the component's toolbar"
}
];
module.exports = {
editor: {
name: "Editor",
description: "Editor is rich text editor component based on Quill.",
name: 'Editor',
description: 'Editor is rich text editor component based on Quill.',
props: EditorProps,
events: EditorEvents,
slots: EditorSlots

55
api-generator/components/fieldset.js
View File

@ -1,45 +1,44 @@
const FieldsetProps = [
{
name: "legend",
type: "string",
default: "null",
description: "Header text of the fieldset."
name: 'legend',
type: 'string',
default: 'null',
description: 'Header text of the fieldset.'
},
{
name: "toggleable",
type: "boolean",
default: "null",
description:
"When specified, content can toggled by clicking the legend."
name: 'toggleable',
type: 'boolean',
default: 'null',
description: 'When specified, content can toggled by clicking the legend.'
},
{
name: "collapsed",
type: "boolean",
default: "true",
description: "Defines the default visibility state of the content."
name: 'collapsed',
type: 'boolean',
default: 'true',
description: 'Defines the default visibility state of the content.'
},
{
name: "toggleButtonProps",
type: "string",
default: "null",
description: "Uses to pass the custom value to read for the anchor inside the component."
name: 'toggleButtonProps',
type: 'string',
default: 'null',
description: 'Uses to pass the custom value to read for the anchor inside the component.'
}
];
const FieldsetEvents = [
{
name: "toggle",
description: "Callback to invoke when a tab gets expanded or collapsed.",
name: 'toggle',
description: 'Callback to invoke when a tab gets expanded or collapsed.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "boolean",
description: "collapsed state as a boolean"
name: 'event.value',
type: 'boolean',
description: 'collapsed state as a boolean'
}
]
}
@ -47,15 +46,15 @@ const FieldsetEvents = [
const FieldsetSlots = [
{
name: "legend",
name: 'legend',
description: "Custom content for the component's header"
}
];
module.exports = {
fieldset: {
name: "Fieldset",
description: "Fieldset is a grouping component with the optional content toggle feature.",
name: 'Fieldset',
description: 'Fieldset is a grouping component with the optional content toggle feature.',
props: FieldsetProps,
events: FieldsetEvents,
slots: FieldsetSlots

320
api-generator/components/fileupload.js
View File

@ -1,275 +1,275 @@
const FileUploadProps = [
{
name: "name",
type: "string",
default: "null",
description: "Name of the request parameter to identify the files at backend."
name: 'name',
type: 'string',
default: 'null',
description: 'Name of the request parameter to identify the files at backend.'
},
{
name: "url",
type: "string",
default: "null",
description: "Remote url to upload the files."
name: 'url',
type: 'string',
default: 'null',
description: 'Remote url to upload the files.'
},
{
name: "mode",
type: "string",
default: "advanced",
name: 'mode',
type: 'string',
default: 'advanced',
description: 'Defines the UI of the component, possible values are "advanced" and "basic".'
},
{
name: "multiple",
type: "boolean",
default: "false",
description: "Used to select multiple files at once from file dialog."
name: 'multiple',
type: 'boolean',
default: 'false',
description: 'Used to select multiple files at once from file dialog.'
},
{
name: "accept",
type: "string",
default: "null",
name: 'accept',
type: 'string',
default: 'null',
description: 'Pattern to restrict the allowed file types such as "image/*".'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "Disables the upload functionality."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'Disables the upload functionality.'
},
{
name: "auto",
type: "boolean",
default: "false",
description: "When enabled, upload begins automatically after selection is completed."
name: 'auto',
type: 'boolean',
default: 'false',
description: 'When enabled, upload begins automatically after selection is completed.'
},
{
name: "maxFileSize",
type: "number",
default: "null",
description: "Maximum file size allowed in bytes."
name: 'maxFileSize',
type: 'number',
default: 'null',
description: 'Maximum file size allowed in bytes.'
},
{
name: "invalidFileSizeMessage",
type: "string",
name: 'invalidFileSizeMessage',
type: 'string',
default: '"{0}: Invalid file size, file size should be smaller than {1}."',
description: "Message of the invalid fize size."
description: 'Message of the invalid fize size.'
},
{
name: "invalidFileLimitMessage",
type: "string",
default: "Maximum number of files exceeded, limit is {0} at most.",
description: "Message to display when number of files to be uploaded exceeeds the limit."
name: 'invalidFileLimitMessage',
type: 'string',
default: 'Maximum number of files exceeded, limit is {0} at most.',
description: 'Message to display when number of files to be uploaded exceeeds the limit.'
},
{
name: "fileLimit",
type: "number",
default: "null",
description: "Maximum number of files that can be uploaded."
name: 'fileLimit',
type: 'number',
default: 'null',
description: 'Maximum number of files that can be uploaded.'
},
{
name: "withCredentials",
type: "boolean",
default: "false",
description: "Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates."
name: 'withCredentials',
type: 'boolean',
default: 'false',
description: 'Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates.'
},
{
name: "previewWidth",
type: "number",
default: "50",
description: "Width of the image thumbnail in pixels."
name: 'previewWidth',
type: 'number',
default: '50',
description: 'Width of the image thumbnail in pixels.'
},
{
name: "chooseLabel",
type: "string",
default: "null",
description: "Label of the choose button. Defaults to PrimeVue Locale configuration."
name: 'chooseLabel',
type: 'string',
default: 'null',
description: 'Label of the choose button. Defaults to PrimeVue Locale configuration.'
},
{
name: "uploadLabel",
type: "string",
default: "Upoad",
description: "Label of the upload button. Defaults to PrimeVue Locale configuration."
name: 'uploadLabel',
type: 'string',
default: 'Upoad',
description: 'Label of the upload button. Defaults to PrimeVue Locale configuration.'
},
{
name: "cancelLabel",
type: "string",
default: "Cancel",
description: "Label of the cancel button. Defaults to PrimeVue Locale configuration."
name: 'cancelLabel',
type: 'string',
default: 'Cancel',
description: 'Label of the cancel button. Defaults to PrimeVue Locale configuration.'
},
{
name: "customUpload",
type: "boolean",
default: "false",
description: "Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration."
name: 'customUpload',
type: 'boolean',
default: 'false',
description: 'Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeVue Locale configuration.'
},
{
name: "showUploadButton",
type: "boolean",
default: "true",
description: "Whether to show the upload button."
name: 'showUploadButton',
type: 'boolean',
default: 'true',
description: 'Whether to show the upload button.'
},
{
name: "showCancelButton",
type: "boolean",
default: "true",
description: "Whether to cancel the upload button."
name: 'showCancelButton',
type: 'boolean',
default: 'true',
description: 'Whether to cancel the upload button.'
},
{
name: "chooseIcon",
type: "string",
default: "pi pi-plus",
description: "Icon of the choose button."
name: 'chooseIcon',
type: 'string',
default: 'pi pi-plus',
description: 'Icon of the choose button.'
},
{
name: "uploadIcon",
type: "string",
default: "pi pi-upload",
description: "Icon of the upload button."
name: 'uploadIcon',
type: 'string',
default: 'pi pi-upload',
description: 'Icon of the upload button.'
},
{
name: "cancelIcon",
type: "string",
default: "pi pi-times",
description: "Icon of the cancel button."
name: 'cancelIcon',
type: 'string',
default: 'pi pi-times',
description: 'Icon of the cancel button.'
},
{
name: "style",
type: "any",
default: "null",
description: "Inline style of the component."
name: 'style',
type: 'any',
default: 'null',
description: 'Inline style of the component.'
},
{
name: "class",
type: "string",
default: "null",
description: "Style class of the component."
name: 'class',
type: 'string',
default: 'null',
description: 'Style class of the component.'
}
];
const FileUploadEvents = [
{
name: "before-upload",
description: "Callback to invoke before file upload begins to customize the request such as post parameters before the files.",
name: 'before-upload',
description: 'Callback to invoke before file upload begins to customize the request such as post parameters before the files.',
arguments: [
{
name: "event.xhr",
type: "object",
description: "XmlHttpRequest instance."
name: 'event.xhr',
type: 'object',
description: 'XmlHttpRequest instance.'
},
{
name: "event.formData",
type: "object",
description: "FormData object."
name: 'event.formData',
type: 'object',
description: 'FormData object.'
}
]
},
{
name: "before-send",
description: "Callback to invoke before file send begins to customize the request such as adding headers.",
name: 'before-send',
description: 'Callback to invoke before file send begins to customize the request such as adding headers.',
arguments: [
{
name: "event.xhr",
type: "object",
description: "XmlHttpRequest instance."
name: 'event.xhr',
type: 'object',
description: 'XmlHttpRequest instance.'
},
{
name: "event.formData",
type: "object",
description: "FormData object."
name: 'event.formData',
type: 'object',
description: 'FormData object.'
}
]
},
{
name: "upload",
description: "Callback to invoke when file upload is complete.",
name: 'upload',
description: 'Callback to invoke when file upload is complete.',
arguments: [
{
name: "event.xhr",
type: "object",
description: "XmlHttpRequest instance."
name: 'event.xhr',
type: 'object',
description: 'XmlHttpRequest instance.'
},
{
name: "event.files",
type: "object",
description: "Uploaded files."
name: 'event.files',
type: 'object',
description: 'Uploaded files.'
}
]
},
{
name: "error",
description: "Callback to invoke if file upload fails.",
name: 'error',
description: 'Callback to invoke if file upload fails.',
arguments: [
{
name: "event.xhr",
type: "object",
description: "XmlHttpRequest instance."
name: 'event.xhr',
type: 'object',
description: 'XmlHttpRequest instance.'
},
{
name: "event.files",
type: "object",
description: "Files that are not uploaded."
name: 'event.files',
type: 'object',
description: 'Files that are not uploaded.'
}
]
},
{
name: "clear",
description: "Callback to invoke when files in queue are removed without uploading."
name: 'clear',
description: 'Callback to invoke when files in queue are removed without uploading.'
},
{
name: "select",
description: "Callback to invoke when file upload is complete.",
name: 'select',
description: 'Callback to invoke when file upload is complete.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original browser event."
name: 'event.originalEvent',
type: 'object',
description: 'Original browser event.'
},
{
name: "event.files",
type: "object",
description: "List of selected files."
name: 'event.files',
type: 'object',
description: 'List of selected files.'
}
]
},
{
name: "progress",
description: "Callback to invoke when files are selected.",
name: 'progress',
description: 'Callback to invoke when files are selected.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original browser event."
name: 'event.originalEvent',
type: 'object',
description: 'Original browser event.'
},
{
name: "event.progress",
type: "number",
description: "Calculated progress value."
name: 'event.progress',
type: 'number',
description: 'Calculated progress value.'
}
]
},
{
name: "uploader",
description: "Callback to invoke to implement a custom upload.",
name: 'uploader',
description: 'Callback to invoke to implement a custom upload.',
arguments: [
{
name: "event.files",
type: "object",
description: "List of selected files."
name: 'event.files',
type: 'object',
description: 'List of selected files.'
}
]
},
{
name: "remove",
description: "Callback to invoke when a singe file is removed from the list.",
name: 'remove',
description: 'Callback to invoke when a singe file is removed from the list.',
arguments: [
{
name: "event.file",
type: "object",
description: "Removed file."
name: 'event.file',
type: 'object',
description: 'Removed file.'
},
{
name: "event.files",
type: "object",
description: "Remaining files to be uploaded."
name: 'event.files',
type: 'object',
description: 'Remaining files to be uploaded.'
}
]
}
@ -277,15 +277,15 @@ const FileUploadEvents = [
const FileUploadSlots = [
{
name: "empty",
description: "Custom content when there is no selected file"
name: 'empty',
description: 'Custom content when there is no selected file'
}
];
module.exports = {
fileupload: {
name: "FileUpload",
description: "FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.",
name: 'FileUpload',
description: 'FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.',
props: FileUploadProps,
events: FileUploadEvents,
slots: FileUploadSlots

20
api-generator/components/fullcalendar.js
View File

@ -1,22 +1,22 @@
const FullCalendarProps = [
{
name: "events",
type: "array",
default: "null",
description: "An array of events to display."
name: 'events',
type: 'array',
default: 'null',
description: 'An array of events to display.'
},
{
name: "options",
type: "object",
default: "null",
description: "A configuration object to define properties of FullCalendar."
name: 'options',
type: 'object',
default: 'null',
description: 'A configuration object to define properties of FullCalendar.'
}
];
module.exports = {
fullcalendar: {
name: "FullCalendar",
description: "An event calendar based on the FullCalendar library.",
name: 'FullCalendar',
description: 'An event calendar based on the FullCalendar library.',
props: FullCalendarProps
}
};

208
api-generator/components/galleria.js
View File

@ -1,181 +1,181 @@
const GalleriaProps = [
{
name: "id",
type: "string",
default: "null",
description: "Unique identifier of the element."
name: 'id',
type: 'string',
default: 'null',
description: 'Unique identifier of the element.'
},
{
name: "value",
type: "array",
default: "null",
description: "An array of objects to display."
name: 'value',
type: 'array',
default: 'null',
description: 'An array of objects to display.'
},
{
name: "activeIndex",
type: "number",
default: "0",
description: "Index of the first item."
name: 'activeIndex',
type: 'number',
default: '0',
description: 'Index of the first item.'
},
{
name: "fullscreen",
type: "boolean",
default: "false",
description: "Whether to display the component on fullscreen."
name: 'fullscreen',
type: 'boolean',
default: 'false',
description: 'Whether to display the component on fullscreen.'
},
{
name: "visible",
type: "boolean",
default: "false",
description: "Specifies the visibility of the mask on fullscreen mode."
name: 'visible',
type: 'boolean',
default: 'false',
description: 'Specifies the visibility of the mask on fullscreen mode.'
},
{
name: "numVisible",
type: "number",
default: "3",
description: "Number of items per page."
name: 'numVisible',
type: 'number',
default: '3',
description: 'Number of items per page.'
},
{
name: "responsiveOptions",
type: "any",
default: "null",
description: "An array of options for responsive design."
name: 'responsiveOptions',
type: 'any',
default: 'null',
description: 'An array of options for responsive design.'
},
{
name: "showItemNavigators",
type: "boolean",
default: "false",
description: "Whether to display navigation buttons in item section."
name: 'showItemNavigators',
type: 'boolean',
default: 'false',
description: 'Whether to display navigation buttons in item section.'
},
{
name: "showThumbnailNavigators",
type: "boolean",
default: "true",
description: "Whether to display navigation buttons in thumbnail container."
name: 'showThumbnailNavigators',
type: 'boolean',
default: 'true',
description: 'Whether to display navigation buttons in thumbnail container.'
},
{
name: "showItemNavigatorsOnHover",
type: "boolean",
default: "false",
description: "Whether to display navigation buttons on item hover."
name: 'showItemNavigatorsOnHover',
type: 'boolean',
default: 'false',
description: 'Whether to display navigation buttons on item hover.'
},
{
name: "changeItemOnIndicatorHover",
type: "boolean",
default: "false",
description: "When enabled, item is changed on indicator hover."
name: 'changeItemOnIndicatorHover',
type: 'boolean',
default: 'false',
description: 'When enabled, item is changed on indicator hover.'
},
{
name: "circular",
type: "boolean",
default: "false",
description: "Defines if scrolling would be infinite."
name: 'circular',
type: 'boolean',
default: 'false',
description: 'Defines if scrolling would be infinite.'
},
{
name: "autoPlay",
type: "boolean",
default: "false",
description: "Items are displayed with a slideshow in autoPlay mode."
name: 'autoPlay',
type: 'boolean',
default: 'false',
description: 'Items are displayed with a slideshow in autoPlay mode.'
},
{
name: "transitionInterval",
type: "number",
default: "4000",
description: "Time in milliseconds to scroll items."
name: 'transitionInterval',
type: 'number',
default: '4000',
description: 'Time in milliseconds to scroll items.'
},
{
name: "showThumbnails",
type: "boolean",
default: "true",
description: "Whether to display thumbnail container."
name: 'showThumbnails',
type: 'boolean',
default: 'true',
description: 'Whether to display thumbnail container.'
},
{
name: "thumbnailsPosition",
type: "string",
default: "bottom",
name: 'thumbnailsPosition',
type: 'string',
default: 'bottom',
description: 'Position of thumbnails. Valid values are "bottom", "top", "left" and "right".'
},
{
name: "verticalThumbnailViewPortHeight",
type: "string",
default: "300px",
description: "Height of the viewport in vertical thumbnail."
name: 'verticalThumbnailViewPortHeight',
type: 'string',
default: '300px',
description: 'Height of the viewport in vertical thumbnail.'
},
{
name: "showIndicators",
type: "boolean",
default: "false",
description: "Whether to display indicator container."
name: 'showIndicators',
type: 'boolean',
default: 'false',
description: 'Whether to display indicator container.'
},
{
name: "showIndicatorsOnItem",
type: "boolean",
default: "false",
description: "When enabled, indicator container is displayed on item container."
name: 'showIndicatorsOnItem',
type: 'boolean',
default: 'false',
description: 'When enabled, indicator container is displayed on item container.'
},
{
name: "indicatorsPosition",
type: "string",
default: "bottom",
name: 'indicatorsPosition',
type: 'string',
default: 'bottom',
description: 'Position of indicators. Valid values are "bottom", "top", "left" and "right".'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "ase zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'ase zIndex value to use in layering.'
},
{
name: "maskClass",
type: "string",
default: "null",
description: "Style class of the mask on fullscreen mode."
name: 'maskClass',
type: 'string',
default: 'null',
description: 'Style class of the mask on fullscreen mode.'
},
{
name: "containerStyle",
type: "any",
default: "null",
name: 'containerStyle',
type: 'any',
default: 'null',
description: "Inline style of the component on fullscreen mode. Otherwise, the 'style' property can be used."
},
{
name: "containerClass",
type: "any",
default: "null",
name: 'containerClass',
type: 'any',
default: 'null',
description: "Style class of the component on fullscreen mode. Otherwise, the 'class' property can be used."
}
];
const GalleriaSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's header"
},
{
name: "item",
description: "Custom content for the item"
name: 'item',
description: 'Custom content for the item'
},
{
name: "caption",
description: "Custom caption content"
name: 'caption',
description: 'Custom caption content'
},
{
name: "thumbnail",
description: "Custom thumbnail content"
name: 'thumbnail',
description: 'Custom thumbnail content'
},
{
name: "indicator",
description: "Custom indicator content"
name: 'indicator',
description: 'Custom indicator content'
}
];
module.exports = {
galleria: {
name: "Galleria",
description: "Galleria is an advanced content gallery component.",
name: 'Galleria',
description: 'Galleria is an advanced content gallery component.',
props: GalleriaProps,
slots: GalleriaSlots
}

28
api-generator/components/image.js
View File

@ -1,38 +1,38 @@
const ImageProps = [
{
name: "preview",
type: "boolean",
default: "false",
description: "Controls the preview functionality."
name: 'preview',
type: 'boolean',
default: 'false',
description: 'Controls the preview functionality.'
}
];
const ImageEvents = [
{
name: "show",
description: "Triggered when the preview overlay is shown."
name: 'show',
description: 'Triggered when the preview overlay is shown.'
},
{
name: "hide",
description: "Triggered when the preview overlay is hidden."
name: 'hide',
description: 'Triggered when the preview overlay is hidden.'
},
{
name: "error",
description: "Triggered when an error occurs while loading an image file."
name: 'error',
description: 'Triggered when an error occurs while loading an image file.'
}
];
const ImageSlots = [
{
name: "indicator",
description: "Custom content for the preview indicator"
name: 'indicator',
description: 'Custom content for the preview indicator'
}
];
module.exports = {
image: {
name: "Image",
description: "Displays an image with preview and tranformation options.",
name: 'Image',
description: 'Displays an image with preview and tranformation options.',
props: ImageProps,
events: ImageEvents,
slots: ImageSlots

12
api-generator/components/inlinemessage.js
View File

@ -1,17 +1,17 @@
const InlineMessageProps = [
{
name: "severity",
type: "string",
default: "error",
name: 'severity',
type: 'string',
default: 'error',
description: 'Severity level of the message. Valid severities are "success", "info", "warn" and "error".'
}
];
module.exports = {
inlinemessage: {
name: "InlineMessage",
description: "InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms",
"doc-url": "message",
name: 'InlineMessage',
description: 'InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms',
'doc-url': 'message',
props: InlineMessageProps
}
};

56
api-generator/components/inplace.js
View File

@ -1,44 +1,44 @@
const InplaceProps = [
{
name: "active",
type: "boolean",
default: "false",
description: "Whether the content is displayed or not."
name: 'active',
type: 'boolean',
default: 'false',
description: 'Whether the content is displayed or not.'
},
{
name: "closable",
type: "boolean",
default: "false",
description: "Displays a button to switch back to display mode."
name: 'closable',
type: 'boolean',
default: 'false',
description: 'Displays a button to switch back to display mode.'
},
{
name: "diabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'diabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
}
];
const InplaceEvents = [
{
name: "open",
description: "Callback to invoke when inplace is opened.",
name: 'open',
description: 'Callback to invoke when inplace is opened.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "close",
description: "Callback to invoke when inplace is closed.",
name: 'close',
description: 'Callback to invoke when inplace is closed.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -46,19 +46,19 @@ const InplaceEvents = [
const InplaceSlots = [
{
name: "display",
description: "Output content"
name: 'display',
description: 'Output content'
},
{
name: "content",
description: "Actual content"
name: 'content',
description: 'Actual content'
}
];
module.exports = {
inplace: {
name: "Inplace",
description: "Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.",
name: 'Inplace',
description: 'Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.',
props: InplaceProps,
events: InplaceEvents,
slots: InplaceSlots

44
api-generator/components/inputmask.js
View File

@ -1,40 +1,40 @@
const InputMaskProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "mask",
type: "string",
default: "null",
description: "Mask pattern."
name: 'mask',
type: 'string',
default: 'null',
description: 'Mask pattern.'
},
{
name: "slotChar",
type: "string",
default: "-",
description: "Placeholder character in mask, default is underscore."
name: 'slotChar',
type: 'string',
default: '-',
description: 'Placeholder character in mask, default is underscore.'
},
{
name: "autoClear",
type: "boolean",
default: "true",
description: "Clears the incomplete value on blur."
name: 'autoClear',
type: 'boolean',
default: 'true',
description: 'Clears the incomplete value on blur.'
},
{
name: "unmask",
type: "boolean",
default: "false",
description: "Defines if model sets the raw unmasked value to bound value or the formatted mask value."
name: 'unmask',
type: 'boolean',
default: 'false',
description: 'Defines if model sets the raw unmasked value to bound value or the formatted mask value.'
}
];
module.exports = {
inputmask: {
name: "InputMask",
description: "InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.",
name: 'InputMask',
description: 'InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.',
props: InputMaskProps
}
};

284
api-generator/components/inputnumber.js
View File

@ -1,227 +1,231 @@
const InputNumberProps = [
{
name: "modelValue",
type: "number",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'number',
default: 'null',
description: 'Value of the component.'
},
{
name: "format",
type: "boolean",
default: "true",
description: "Whether to format the value."
name: 'format',
type: 'boolean',
default: 'true',
description: 'Whether to format the value.'
},
{
name: "showButtons",
type: "boolean",
default: "false",
description: "Displays spinner buttons."
name: 'showButtons',
type: 'boolean',
default: 'false',
description: 'Displays spinner buttons.'
},
{
name: "buttonLayout",
type: "string",
default: "stacked",
name: 'buttonLayout',
type: 'string',
default: 'stacked',
description: 'Layout of the buttons, valid values are "stacked" (default), "horizontal" and "vertical".'
},
{
name: "incrementButtonClass",
type: "string",
default: "null",
description: "Style class of the increment button."
name: 'incrementButtonClass',
type: 'string',
default: 'null',
description: 'Style class of the increment button.'
},
{
name: "decrementButtonClass",
type: "string",
default: "null",
description: "Style class of the decrement button."
name: 'decrementButtonClass',
type: 'string',
default: 'null',
description: 'Style class of the decrement button.'
},
{
name: "incrementButtonIcon",
type: "string",
default: "pi pi-angle-up",
description: "Style class of the increment button."
name: 'incrementButtonIcon',
type: 'string',
default: 'pi pi-angle-up',
description: 'Style class of the increment button.'
},
{
name: "decrementButtonIcon",
type: "string",
default: "pi pi-angle-down",
description: "Style class of the decrement button."
name: 'decrementButtonIcon',
type: 'string',
default: 'pi pi-angle-down',
description: 'Style class of the decrement button.'
},
{
name: "locale",
type: "string",
default: "null",
description: "Locale to be used in formatting."
name: 'locale',
type: 'string',
default: 'null',
description: 'Locale to be used in formatting.'
},
{
name: "localeMatcher",
type: "string",
default: "best fit",
name: 'localeMatcher',
type: 'string',
default: 'best fit',
description: 'The locale matching algorithm to use. Possible values are "lookup" and "best fit".'
},
{
name: "mode",
type: "string",
default: "decimal",
name: 'mode',
type: 'string',
default: 'decimal',
description: 'Defines the behavior of the component, valid values are "decimal" and "currency".'
},
{
name: "prefix",
type: "string",
default: "null",
description: "Text to display before the value."
name: 'prefix',
type: 'string',
default: 'null',
description: 'Text to display before the value.'
},
{
name: "suffix",
type: "string",
default: "decimal",
description: "Text to display after the value."
name: 'suffix',
type: 'string',
default: 'decimal',
description: 'Text to display after the value.'
},
{
name: "currency",
type: "string",
default: "null",
description: 'The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB. There is no default value; if the style is "currency", the currency property must be provided.'
name: 'currency',
type: 'string',
default: 'null',
description:
'The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB. There is no default value; if the style is "currency", the currency property must be provided.'
},
{
name: "currencyDisplay",
type: "string",
default: "symbol",
description: 'How to display the currency in currency formatting. Possible values are "symbol" to use a localized currency symbol such as €, "code" to use the ISO currency code, "name" to use a localized currency name such as "dollar"; the default is "symbol".'
name: 'currencyDisplay',
type: 'string',
default: 'symbol',
description:
'How to display the currency in currency formatting. Possible values are "symbol" to use a localized currency symbol such as €, "code" to use the ISO currency code, "name" to use a localized currency name such as "dollar"; the default is "symbol".'
},
{
name: "useGrouping",
type: "boolean",
default: "true",
description: "Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators."
name: 'useGrouping',
type: 'boolean',
default: 'true',
description: 'Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators.'
},
{
name: "minFractionDigits",
type: "number",
default: "null",
description: "The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information)."
name: 'minFractionDigits',
type: 'number',
default: 'null',
description:
"The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information)."
},
{
name: "maxFractionDigits",
type: "number",
default: "null",
description: "The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3; the default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information)."
name: 'maxFractionDigits',
type: 'number',
default: 'null',
description:
"The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3; the default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information)."
},
{
name: "min",
type: "number",
default: "null",
description: "Mininum boundary value."
name: 'min',
type: 'number',
default: 'null',
description: 'Mininum boundary value.'
},
{
name: "max",
type: "number",
default: "null",
description: "Maximum boundary value."
name: 'max',
type: 'number',
default: 'null',
description: 'Maximum boundary value.'
},
{
name: "step",
type: "number",
default: "1",
description: "Step factor to increment/decrement the value."
name: 'step',
type: 'number',
default: '1',
description: 'Step factor to increment/decrement the value.'
},
{
name: "allowEmpty",
type: "boolean",
default: "true",
description: "Determines whether the input field is empty."
name: 'allowEmpty',
type: 'boolean',
default: 'true',
description: 'Determines whether the input field is empty.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "When present, it specifies that an input field is read-only."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that an input field is read-only.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Placeholder text for the input."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text for the input.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
},
{
name: "incrementButtonProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLButtonElement to increment button inside the component."
name: 'incrementButtonProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLButtonElement to increment button inside the component.'
},
{
name: "decrementButtonProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLButtonElement to decrement button inside the component."
name: 'decrementButtonProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLButtonElement to decrement button inside the component.'
}
];
const InputNumberEvents = [
{
name: "input",
description: "Callback to invoke when the value is entered.",
name: 'input',
description: 'Callback to invoke when the value is entered.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "number",
description: "New value"
name: 'event.value',
type: 'number',
description: 'New value'
}
]
},
{
name: "focus",
description: "Callback to invoke on focus of input field.",
name: 'focus',
description: 'Callback to invoke on focus of input field.',
arguments: [
{
name: "event",
type: "object",
description: "Focus event"
name: 'event',
type: 'object',
description: 'Focus event'
}
]
},
{
name: "blur",
description: "Callback to invoke on blur of input field.",
name: 'blur',
description: 'Callback to invoke on blur of input field.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Input value"
name: 'event.value',
type: 'string',
description: 'Input value'
}
]
}
@ -229,8 +233,8 @@ const InputNumberEvents = [
module.exports = {
inputnumber: {
name: "InputNumber",
description: "InputNumber is an input component to provide numerical input.",
name: 'InputNumber',
description: 'InputNumber is an input component to provide numerical input.',
props: InputNumberProps,
events: InputNumberEvents
}

72
api-generator/components/inputswitch.js
View File

@ -1,67 +1,67 @@
const InputSwitchProps = [
{
name: "modelValue",
type: "boolean",
default: "null",
description: "Specifies whether a inputswitch should be checked or not."
name: 'modelValue',
type: 'boolean',
default: 'null',
description: 'Specifies whether a inputswitch should be checked or not.'
},
{
name: "trueValue",
type: "any",
default: "null",
description: "Value in checked state."
name: 'trueValue',
type: 'any',
default: 'null',
description: 'Value in checked state.'
},
{
name: "falseValue",
type: "any",
default: "null",
description: "Value in unchecked state."
name: 'falseValue',
type: 'any',
default: 'null',
description: 'Value in unchecked state.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
}
];
const InputSwitchEvents = [
{
name: "click",
description: "Callback to invoke on click."
name: 'click',
description: 'Callback to invoke on click.'
},
{
name: "change",
description: "Callback to invoke on value change."
name: 'change',
description: 'Callback to invoke on value change.'
},
{
name: "input",
description: "Callback to invoke on value change."
name: 'input',
description: 'Callback to invoke on value change.'
}
];
module.exports = {
inputswitch: {
name: "InputSwitch",
description: "InputSwitch is used to select a boolean value.",
name: 'InputSwitch',
description: 'InputSwitch is used to select a boolean value.',
props: InputSwitchProps,
events: InputSwitchEvents
}

12
api-generator/components/inputtext.js
View File

@ -1,16 +1,16 @@
const InputTextProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
}
];
module.exports = {
inputtext: {
name: "InputText",
description: "InputText renders a text field to enter data.",
name: 'InputText',
description: 'InputText renders a text field to enter data.',
props: InputTextProps
}
};

142
api-generator/components/knob.js
View File

@ -1,111 +1,111 @@
const KnobProps = [
{
name: "modelValue",
type: "number",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'number',
default: 'null',
description: 'Value of the component.'
},
{
name: "size",
type: "number",
default: "100",
description: "Size of the component in pixels."
name: 'size',
type: 'number',
default: '100',
description: 'Size of the component in pixels.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "When present, it specifies that the component value cannot be edited."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component value cannot be edited.'
},
{
name: "step",
type: "number",
default: "null",
description: "Step factor to increment/decrement the value."
name: 'step',
type: 'number',
default: 'null',
description: 'Step factor to increment/decrement the value.'
},
{
name: "min",
type: "number",
default: "0",
description: "Mininum boundary value."
name: 'min',
type: 'number',
default: '0',
description: 'Mininum boundary value.'
},
{
name: "max",
type: "number",
default: "100",
description: "Maximum boundary value."
name: 'max',
type: 'number',
default: '100',
description: 'Maximum boundary value.'
},
{
name: "valueColor",
type: "string",
default: "null",
description: "Background of the value."
name: 'valueColor',
type: 'string',
default: 'null',
description: 'Background of the value.'
},
{
name: "rangeColor",
type: "string",
default: "null",
description: "Background color of the range."
name: 'rangeColor',
type: 'string',
default: 'null',
description: 'Background color of the range.'
},
{
name: "textColor",
type: "string",
default: "null",
description: "Color of the value text."
name: 'textColor',
type: 'string',
default: 'null',
description: 'Color of the value text.'
},
{
name: "strokeWidth",
type: "number",
default: "14",
description: "Width of the knob stroke."
name: 'strokeWidth',
type: 'number',
default: '14',
description: 'Width of the knob stroke.'
},
{
name: "showValue",
type: "boolean",
default: "true",
description: "Whether the show the value inside the knob."
name: 'showValue',
type: 'boolean',
default: 'true',
description: 'Whether the show the value inside the knob.'
},
{
name: "valueTemplate",
type: "string",
default: "{value}",
description: "Template string of the value."
name: 'valueTemplate',
type: 'string',
default: '{value}',
description: 'Template string of the value.'
},
{
name: "tabindex",
type: "number",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const KnobEvents = [
{
name: "change",
description: "Callback to invoke when the value changes.",
name: 'change',
description: 'Callback to invoke when the value changes.',
arguments: [
{
name: "value",
type: "number",
description: "New value"
name: 'value',
type: 'number',
description: 'New value'
}
]
}
@ -113,8 +113,8 @@ const KnobEvents = [
module.exports = {
knob: {
name: "Knob",
description: "Knob is a form component to define number inputs with a dial.",
name: 'Knob',
description: 'Knob is a form component to define number inputs with a dial.',
props: KnobProps,
events: KnobEvents
}

309
api-generator/components/listbox.js
View File

@ -1,232 +1,233 @@
const ListboxProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
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: 'options',
type: 'array',
default: 'null',
description: 'An array of selectitems to display as the available options.'
},
{
name: "optionLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option."
name: 'optionLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option.'
},
{
name: "optionValue",
type: "string | function",
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: 'optionValue',
type: 'string | function',
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 | function",
default: "null",
description: "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined."
name: 'optionDisabled',
type: 'boolean | function',
default: 'null',
description: 'Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.'
},
{
name: "optionGroupLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option group."
name: 'optionGroupLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option group.'
},
{
name: "optionGroupChildren",
type: "string | function",
default: "null",
description: "Property name or getter function that refers to the children options of option group."
name: 'optionGroupChildren',
type: 'string | function',
default: 'null',
description: 'Property name or getter function that refers to the children options of option group.'
},
{
name: "listStyle",
type: "string",
default: "null",
description: "Inline style of inner list element."
name: 'listStyle',
type: 'string',
default: 'null',
description: 'Inline style of inner list element.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When specified, disables the component."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When specified, disables the component.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'A property to uniquely identify an option.'
},
{
name: "multiple",
type: "boolean",
default: "false",
description: "When specified, allows selecting multiple values."
name: 'multiple',
type: 'boolean',
default: 'false',
description: 'When specified, allows selecting multiple values.'
},
{
name: "metaKeySelection",
type: "boolean",
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."
name: 'metaKeySelection',
type: 'boolean',
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.'
},
{
name: "filter",
type: "boolean",
default: "false",
description: "When specified, displays a filter input at header."
name: 'filter',
type: 'boolean',
default: 'false',
description: 'When specified, displays a filter input at header.'
},
{
name: "filterPlaceholder",
type: "string",
default: "null",
description: "Placeholder text to show when filter input is empty."
name: 'filterPlaceholder',
type: 'string',
default: 'null',
description: 'Placeholder text to show when filter input is empty.'
},
{
name: "filterLocale",
type: "string",
default: "undefined",
name: 'filterLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in filtering. The default locale is the host environment's current locale."
},
{
name: "filterMatchMode",
type: "string",
default: "contains",
name: 'filterMatchMode',
type: 'string',
default: 'contains',
description: 'Defines the filtering algorithm to use when searching the options. Valid values are "contains" (default), "startsWith" and "endsWith"'
},
{
name: "filterFields",
type: "array",
default: "null",
description: "Fields used when filtering the options, defaults to optionLabel."
name: 'filterFields',
type: 'array',
default: 'null',
description: 'Fields used when filtering the options, defaults to optionLabel.'
},
{
name: "filterInputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the filter input inside the component."
name: 'filterInputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the filter input inside the component.'
},
{
name: "virtualScrollerOptions",
type: "object",
default: "null",
description: "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it."
name: 'virtualScrollerOptions',
type: 'object',
default: 'null',
description: 'Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.'
},
{
name: "autoOptionFocus",
type: "boolean",
default: "true",
description: "Whether to focus on the first visible or selected element."
name: 'autoOptionFocus',
type: 'boolean',
default: 'true',
description: 'Whether to focus on the first visible or selected element.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused option is selected."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused option is selected.'
},
{
name: "filterMessage",
type: "string",
default: "{0} results are available",
description: "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
name: 'filterMessage',
type: 'string',
default: '{0} results are available',
description: 'Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "selectionMessage",
type: "string",
default: "{0} items selected",
description: "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
name: 'selectionMessage',
type: 'string',
default: '{0} items selected',
description: 'Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySelectionMessage",
type: "string",
default: "No selected item",
description: "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
name: 'emptySelectionMessage',
type: 'string',
default: 'No selected item',
description: 'Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyFilterMessage",
type: "string",
default: "No results found",
description: "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
name: 'emptyFilterMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyMessage",
type: "string",
default: "No results found",
description: "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
name: 'emptyMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
}
];
const ListboxEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "object",
description: "Selected option value"
name: 'event.value',
type: 'object',
description: 'Selected option value'
}
]
},
{
name: "focus",
description: "Callback to invoke when component receives focus.",
name: 'focus',
description: 'Callback to invoke when component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when component loses focus.",
name: 'blur',
description: 'Callback to invoke when component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "filter",
description: "Callback to invoke on filter input.",
name: 'filter',
description: 'Callback to invoke on filter input.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Filter value"
name: 'event.value',
type: 'string',
description: 'Filter value'
}
]
}
@ -234,43 +235,43 @@ const ListboxEvents = [
const ListboxSlots = [
{
name: "option",
name: 'option',
description: "Custom content for the item's option"
},
{
name: "optiongroup",
name: 'optiongroup',
description: "Custom content for the item's optiongroup"
},
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
},
{
name: "emptyfilter",
description: "Custom content when there is no filtered data to display"
name: 'emptyfilter',
description: 'Custom content when there is no filtered data to display'
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "content",
description: "Custom content for the virtual scroller"
name: 'content',
description: 'Custom content for the virtual scroller'
},
{
name: "loader",
description: "Custom content for the virtual scroller loader items"
name: 'loader',
description: 'Custom content for the virtual scroller loader items'
}
];
module.exports = {
listbox: {
name: "Listbox",
description: "Listbox is used to select one or more values from a list of items.",
name: 'Listbox',
description: 'Listbox is used to select one or more values from a list of items.',
props: ListboxProps,
events: ListboxEvents,
slots: ListboxSlots

38
api-generator/components/megamenu.js
View File

@ -1,43 +1,43 @@
const MegaMenuProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "orientation",
type: "string",
default: "horizontal",
description: "Defines the orientation, valid values are horizontal and vertical."
name: 'orientation',
type: 'string',
default: 'horizontal',
description: 'Defines the orientation, valid values are horizontal and vertical.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const MegaMenuSlots = [
{
name: "start",
description: "Custom content before the content"
name: 'start',
description: 'Custom content before the content'
},
{
name: "end",
description: "Custom content after the content"
name: 'end',
description: 'Custom content after the content'
},
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
megamenu: {
name: "MegaMenu",
description: "MegaMenu is navigation component that displays submenus together.",
name: 'MegaMenu',
description: 'MegaMenu is navigation component that displays submenus together.',
props: MegaMenuProps,
slots: MegaMenuSlots
}

62
api-generator/components/menu.js
View File

@ -1,64 +1,64 @@
const MenuProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "popup",
type: "boolean",
default: "false",
description: "Defines if menu would displayed as a popup."
name: 'popup',
type: 'boolean',
default: 'false',
description: 'Defines if menu would displayed as a popup.'
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const MenuEvents = [
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
}
];
const MenuSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
menu: {
name: "Menu",
description: "Menu is a navigation / command component that supports dynamic and static positioning.",
name: 'Menu',
description: 'Menu is a navigation / command component that supports dynamic and static positioning.',
props: MenuProps,
events: MenuEvents,
slots: MenuSlots

30
api-generator/components/menubar.js
View File

@ -1,37 +1,37 @@
const MenubarProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const MenubarSlots = [
{
name: "start",
description: "Custom content before the content"
name: 'start',
description: 'Custom content before the content'
},
{
name: "end",
description: "Custom content after the content"
name: 'end',
description: 'Custom content after the content'
},
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
menubar: {
name: "Menubar",
description: "Menubar is a horizontal menu component.",
name: 'Menubar',
description: 'Menubar is a horizontal menu component.',
props: MenubarProps,
slots: MenubarSlots
}

52
api-generator/components/message.js
View File

@ -1,45 +1,45 @@
const MessageProps = [
{
name: "severity",
type: "string",
default: "info",
name: 'severity',
type: 'string',
default: 'info',
description: 'Severity level of the message. Valid severities are "success", "info", "warn" and "error".'
},
{
name: "closable",
type: "boolean",
default: "true",
description: "Whether the message can be closed manually using the close icon."
name: 'closable',
type: 'boolean',
default: 'true',
description: 'Whether the message can be closed manually using the close icon.'
},
{
name: "sticky",
type: "boolean",
default: "null",
description: "When enabled, message is not removed automatically."
name: 'sticky',
type: 'boolean',
default: 'null',
description: 'When enabled, message is not removed automatically.'
},
{
name: "life",
type: "number",
default: "300",
description: "Delay in milliseconds to close the message automatically."
name: 'life',
type: 'number',
default: '300',
description: 'Delay in milliseconds to close the message automatically.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Display a custom icon for the message."
name: 'icon',
type: 'string',
default: 'null',
description: 'Display a custom icon for the message.'
}
];
const MessageEvents = [
{
name: "close",
description: "Callback to invoke when a message is closed.",
name: 'close',
description: 'Callback to invoke when a message is closed.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -47,8 +47,8 @@ const MessageEvents = [
module.exports = {
message: {
name: "Message",
description: "Messages is used to display inline messages with various severities.",
name: 'Message',
description: 'Messages is used to display inline messages with various severities.',
props: MessageProps,
events: MessageEvents
}

468
api-generator/components/multiselect.js
View File

@ -1,354 +1,354 @@
const MultiSelectProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
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: '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: 'optionLabel',
type: 'string',
default: 'null',
description: 'Property name or getter function to use as the label of an option.'
},
{
name: "optionValue",
type: "string | function",
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: 'optionValue',
type: 'string | function',
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 | function",
default: "null",
description: "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined."
name: 'optionDisabled',
type: 'boolean | function',
default: 'null',
description: 'Property name or getter function to use as the disabled flag of an option, defaults to false when not defined.'
},
{
name: "optionGroupLabel",
type: "string | function",
default: "null",
description: "Property name or getter function to use as the label of an option group."
name: 'optionGroupLabel',
type: 'string | function',
default: 'null',
description: 'Property name or getter function to use as the label of an option group.'
},
{
name: "optionGroupChildren",
type: "string | function",
default: "null",
description: "Property name or getter function that refers to the children options of option group."
name: 'optionGroupChildren',
type: 'string | function',
default: 'null',
description: 'Property name or getter function that refers to the children options of option group.'
},
{
name: "scrollHeight",
type: "string",
default: "200px",
description: "Height of the viewport, a scrollbar is defined if height of list exceeds this value."
name: 'scrollHeight',
type: 'string',
default: '200px',
description: 'Height of the viewport, a scrollbar is defined if height of list exceeds this value.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Label to display when there are no selections."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Label to display when there are no selections.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
},
{
name: "panelStyle",
type: "object",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'object',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel.'
},
{
name: "filterInputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the filter input inside the overlay panel."
name: 'filterInputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the filter input inside the overlay panel.'
},
{
name: "closeButtonProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLButtonElement to the close button inside the overlay panel."
name: 'closeButtonProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLButtonElement to the close button inside the overlay panel.'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "A property to uniquely identify an option."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'A property to uniquely identify an option.'
},
{
name: "filter",
type: "boolean",
default: "false",
description: "When specified, displays a filter input at header."
name: 'filter',
type: 'boolean',
default: 'false',
description: 'When specified, displays a filter input at header.'
},
{
name: "filterPlaceholder",
type: "string",
default: "null",
description: "Placeholder text to show when filter input is empty."
name: 'filterPlaceholder',
type: 'string',
default: 'null',
description: 'Placeholder text to show when filter input is empty.'
},
{
name: "filterLocale",
type: "string",
default: "undefined",
name: 'filterLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in filtering. The default locale is the host environment's current locale."
},
{
name: "filterMatchMode",
type: "string",
default: "contains",
name: 'filterMatchMode',
type: 'string',
default: 'contains',
description: 'Defines the filtering algorithm to use when searching the options. Valid values are "contains" (default), "startsWith" and "endsWith"'
},
{
name: "filterFields",
type: "array",
default: "null",
description: "Fields used when filtering the options, defaults to optionLabel."
name: 'filterFields',
type: 'array',
default: 'null',
description: 'Fields used when filtering the options, defaults to optionLabel.'
},
{
name: "appendTo",
type: "string",
default: "body",
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."
},
{
name: "display",
type: "string",
default: "comma",
name: 'display',
type: 'string',
default: 'comma',
description: 'Defines how the selected items are displayed, valid values are "comma" and "chip".'
},
{
name: "selectedItemsLabel",
type: "string",
default: "{0} items selected",
description: "Label to display after exceeding max selected labels."
name: 'selectedItemsLabel',
type: 'string',
default: '{0} items selected',
description: 'Label to display after exceeding max selected labels.'
},
{
name: "maxSelectedLabels",
type: "number",
default: "null",
description: "Decides how many selected item labels to show at most."
name: 'maxSelectedLabels',
type: 'number',
default: 'null',
description: 'Decides how many selected item labels to show at most.'
},
{
name: "selectionLimit",
type: "number",
default: "null",
description: "Maximum number of selectable items."
name: 'selectionLimit',
type: 'number',
default: 'null',
description: 'Maximum number of selectable items.'
},
{
name: "showToggleAll",
type: "boolean",
default: "false",
description: "Whether to show the header checkbox to toggle the selection of all items at once."
name: 'showToggleAll',
type: 'boolean',
default: 'false',
description: 'Whether to show the header checkbox to toggle the selection of all items at once.'
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Whether the multiselect is in loading state."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Whether the multiselect is in loading state.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner pi-spin",
description: "Icon to display in loading state."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner pi-spin',
description: 'Icon to display in loading state.'
},
{
name: "selectAll",
type: "boolean",
default: "false",
description: "Whether all data is selected."
name: 'selectAll',
type: 'boolean',
default: 'false',
description: 'Whether all data is selected.'
},
{
name: "resetFilterOnHide",
type: "boolean",
default: "false",
description: "Clears the filter value when hiding the dropdown."
name: 'resetFilterOnHide',
type: 'boolean',
default: 'false',
description: 'Clears the filter value when hiding the dropdown.'
},
{
name: "virtualScrollerOptions",
type: "object",
default: "null",
description: "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it."
name: 'virtualScrollerOptions',
type: 'object',
default: 'null',
description: 'Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.'
},
{
name: "autoOptionFocus",
type: "boolean",
default: "true",
description: "Whether to focus on the first visible or selected element when the overlay panel is shown."
name: 'autoOptionFocus',
type: 'boolean',
default: 'true',
description: 'Whether to focus on the first visible or selected element when the overlay panel is shown.'
},
{
name: "autoFilterFocus",
type: "boolean",
default: "false",
description: "Whether to focus on the filter element when the overlay panel is shown."
name: 'autoFilterFocus',
type: 'boolean',
default: 'false',
description: 'Whether to focus on the filter element when the overlay panel is shown.'
},
{
name: "filterMessage",
type: "string",
default: "{0} results are available",
description: "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
name: 'filterMessage',
type: 'string',
default: '{0} results are available',
description: 'Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "selectionMessage",
type: "string",
default: "{0} items selected",
description: "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
name: 'selectionMessage',
type: 'string',
default: '{0} items selected',
description: 'Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptySelectionMessage",
type: "string",
default: "No selected item",
description: "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
name: 'emptySelectionMessage',
type: 'string',
default: 'No selected item',
description: 'Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyFilterMessage",
type: "string",
default: "No results found",
description: "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
name: 'emptyFilterMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration.'
},
{
name: "emptyMessage",
type: "string",
default: "No results found",
description: "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
name: 'emptyMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "aria-label",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
}
];
const MultiSelectEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "array",
description: "Selected option value"
name: 'event.value',
type: 'array',
description: 'Selected option value'
}
]
},
{
name: "focus",
description: "Callback to invoke when component receives focus.",
name: 'focus',
description: 'Callback to invoke when component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when component loses focus.",
name: 'blur',
description: 'Callback to invoke when component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "before-show",
description: "Callback to invoke before the overlay is shown."
name: 'before-show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "before-hide",
description: "Callback to invoke before the overlay is hidden."
name: 'before-hide',
description: 'Callback to invoke before the overlay is hidden.'
},
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
},
{
name: "filter",
description: "Callback to invoke on filter input.",
name: 'filter',
description: 'Callback to invoke on filter input.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "string",
description: "Filter value"
name: 'event.value',
type: 'string',
description: 'Filter value'
}
]
},
{
name: "selectall-change",
description: "Callback to invoke when all data is selected.",
name: 'selectall-change',
description: 'Callback to invoke when all data is selected.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.checked",
type: "boolean",
description: "Whether all data is selected."
name: 'event.checked',
type: 'boolean',
description: 'Whether all data is selected.'
}
]
}
@ -356,55 +356,55 @@ const MultiSelectEvents = [
const MultiSelectSlots = [
{
name: "value",
description: "Custom content for the item value"
name: 'value',
description: 'Custom content for the item value'
},
{
name: "chip",
description: "Custom content for the chip display."
name: 'chip',
description: 'Custom content for the chip display.'
},
{
name: "indicator",
description: "Custom content for the dropdown indicator"
name: 'indicator',
description: 'Custom content for the dropdown indicator'
},
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
},
{
name: "option",
name: 'option',
description: "Custom content for the item's option"
},
{
name: "optiongroup",
name: 'optiongroup',
description: "Custom content for the item's optiongroup"
},
{
name: "emptyfilter",
description: "Custom content when there is no filtered data to display"
name: 'emptyfilter',
description: 'Custom content when there is no filtered data to display'
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "content",
description: "Custom content for the virtual scroller"
name: 'content',
description: 'Custom content for the virtual scroller'
},
{
name: "loader",
description: "Custom content for the virtual scroller loader items"
name: 'loader',
description: 'Custom content for the virtual scroller loader items'
}
];
module.exports = {
multiselect: {
name: "MultiSelect",
description: "MultiSelect is used to multiple values from a list of options.",
name: 'MultiSelect',
description: 'MultiSelect is used to multiple values from a list of options.',
props: MultiSelectProps,
events: MultiSelectEvents,
slots: MultiSelectSlots

122
api-generator/components/orderlist.js
View File

@ -1,90 +1,90 @@
const OrderListProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'Value of the component.'
},
{
name: "selection",
type: "any",
default: "null",
description: "Selected items in the list."
name: 'selection',
type: 'any',
default: 'null',
description: 'Selected items in the list.'
},
{
name: "metaKeySelection",
type: "boolean",
default: "true",
description: "Defines whether metaKey is requred or not for the selection. 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: 'metaKeySelection',
type: 'boolean',
default: 'true',
description:
'Defines whether metaKey is requred or not for the selection. 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: "dataKey",
type: "string",
default: "null",
description: "Name of the field that uniquely identifies the a record in the data."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'Name of the field that uniquely identifies the a record in the data.'
},
{
name: "listStyle",
type: "object",
default: "null",
description: "Inline style of the the list element."
name: 'listStyle',
type: 'object',
default: 'null',
description: 'Inline style of the the list element.'
},
{
name: "responsive",
type: "boolean",
default: "true",
description: "Whether the list optimizes layout based on screen size."
name: 'responsive',
type: 'boolean',
default: 'true',
description: 'Whether the list optimizes layout based on screen size.'
},
{
name: "breakpoint",
type: "string",
default: "960px",
description: "The breakpoint to define the maximum width boundary when responsiveness is enabled."
name: 'breakpoint',
type: 'string',
default: '960px',
description: 'The breakpoint to define the maximum width boundary when responsiveness is enabled.'
},
{
name: "stripedRows",
type: "boolean",
default: "false",
description: "Whether to displays rows with alternating colors."
name: 'stripedRows',
type: 'boolean',
default: 'false',
description: 'Whether to displays rows with alternating colors.'
}
];
const OrderListEvents = [
{
name: "reorder",
description: "Callback to invoke when the list is reordered.",
name: 'reorder',
description: 'Callback to invoke when the list is reordered.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "array",
description: "Ordered list"
name: 'event.value',
type: 'array',
description: 'Ordered list'
},
{
name: "event.direction",
type: "string",
description:
'Direction of the change; "up", "down", "bottom", "top"'
name: 'event.direction',
type: 'string',
description: 'Direction of the change; "up", "down", "bottom", "top"'
}
]
},
{
name: "selection-change",
description: "Callback to invoke when selection changes.",
name: 'selection-change',
description: 'Callback to invoke when selection changes.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "array",
description: "Ordered list"
name: 'event.value',
type: 'array',
description: 'Ordered list'
}
]
}
@ -92,27 +92,27 @@ const OrderListEvents = [
const OrderListSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "item",
description: "Custom content for the item"
name: 'item',
description: 'Custom content for the item'
},
{
name: "controlsstart",
description: "Custom content before the buttons"
name: 'controlsstart',
description: 'Custom content before the buttons'
},
{
name: "controlsend",
description: "Custom content after the buttons"
name: 'controlsend',
description: 'Custom content after the buttons'
}
];
module.exports = {
orderlist: {
name: "OrderList",
description: "OrderList is used to managed the order of a collection.",
name: 'OrderList',
description: 'OrderList is used to managed the order of a collection.',
props: OrderListProps,
events: OrderListEvents,
slots: OrderListSlots

82
api-generator/components/organizationchart.js
View File

@ -1,78 +1,78 @@
const OrganizationChartProps = [
{
name: "value",
type: "any",
default: "null",
description: "Value of the component."
name: 'value',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "selectionKeys",
type: "object",
default: "null",
description: "A map instance of key-value pairs to represented the selected nodes."
name: 'selectionKeys',
type: 'object',
default: 'null',
description: 'A map instance of key-value pairs to represented the selected nodes.'
},
{
name: "selectionMode",
type: "string",
default: "null",
name: 'selectionMode',
type: 'string',
default: 'null',
description: 'Type of the selection, valid values are "single" and "multiple".'
},
{
name: "collapsible",
type: "boolean",
default: "false",
description: "Whether the nodes can be expanded or toggled."
name: 'collapsible',
type: 'boolean',
default: 'false',
description: 'Whether the nodes can be expanded or toggled.'
},
{
name: "collapsedKeys",
type: "object",
default: "null",
description: "A map instance of key-value pairs to represented the collapsed nodes."
name: 'collapsedKeys',
type: 'object',
default: 'null',
description: 'A map instance of key-value pairs to represented the collapsed nodes.'
}
];
const OrganizationChartEvents = [
{
name: "node-select",
description: "Callback to invoke when a node is selected.",
name: 'node-select',
description: 'Callback to invoke when a node is selected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-unselect",
description: "Callback to invoke when a node is unselected.",
name: 'node-unselect',
description: 'Callback to invoke when a node is unselected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-expand",
description: "Callback to invoke when a node is expanded.",
name: 'node-expand',
description: 'Callback to invoke when a node is expanded.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-collapse",
description: "Callback to invoke when a node is collapsed.",
name: 'node-collapse',
description: 'Callback to invoke when a node is collapsed.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
}
@ -80,8 +80,8 @@ const OrganizationChartEvents = [
module.exports = {
organizationchart: {
name: "OrganizationChart",
description: "OrganizationChart visualizes hierarchical organization data.",
name: 'OrganizationChart',
description: 'OrganizationChart visualizes hierarchical organization data.',
props: OrganizationChartProps,
events: OrganizationChartEvents
}

70
api-generator/components/overlaypanel.js
View File

@ -1,63 +1,63 @@
const OverlayPanelProps = [
{
name: "dismissable",
type: "boolean",
default: "true",
description: "Enables to hide the overlay when outside is clicked."
name: 'dismissable',
type: 'boolean',
default: 'true',
description: 'Enables to hide the overlay when outside is clicked.'
},
{
name: "showCloseIcon",
type: "boolean",
default: "false",
description: "When enabled, displays a close icon at top right corner."
name: 'showCloseIcon',
type: 'boolean',
default: 'false',
description: 'When enabled, displays a close icon at top right corner.'
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "ariaCloseLabel",
type: "string",
default: "close",
description: "Aria label of the close icon."
name: 'ariaCloseLabel',
type: 'string',
default: 'close',
description: 'Aria label of the close icon.'
},
{
name: "breakpoints",
type: "object",
default: "null",
description: "Object literal to define widths per screen size."
name: 'breakpoints',
type: 'object',
default: 'null',
description: 'Object literal to define widths per screen size.'
}
];
const OverlayPanelEvents = [
{
name: "show",
description: "Callback to invoke before the overlay is shown."
name: 'show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke before the overlay is hidden."
},
name: 'hide',
description: 'Callback to invoke before the overlay is hidden.'
}
];
module.exports = {
overlaypanel: {
name: "OverlayPanel",
description: "OverlayPanel is a container component positioned as connected to its target.",
name: 'OverlayPanel',
description: 'OverlayPanel is a container component positioned as connected to its target.',
props: OverlayPanelProps,
events: OverlayPanelEvents
}

100
api-generator/components/paginator.js
View File

@ -1,78 +1,78 @@
const PaginatorProps = [
{
name: "totalRecords",
type: "number",
default: "0",
description: "Number of total records."
name: 'totalRecords',
type: 'number',
default: '0',
description: 'Number of total records.'
},
{
name: "rows",
type: "number",
default: "0",
description: "Data count to display per page."
name: 'rows',
type: 'number',
default: '0',
description: 'Data count to display per page.'
},
{
name: "first",
type: "number",
default: "0",
description: "Zero-relative number of the first row to be displayed."
name: 'first',
type: 'number',
default: '0',
description: 'Zero-relative number of the first row to be displayed.'
},
{
name: "pageLinkSize",
type: "number",
default: "5",
description: "Number of page links to display."
name: 'pageLinkSize',
type: 'number',
default: '5',
description: 'Number of page links to display.'
},
{
name: "rowsPerPageOptions",
type: "array",
default: "null",
description: "Array of integer values to display inside rows per page dropdown."
name: 'rowsPerPageOptions',
type: 'array',
default: 'null',
description: 'Array of integer values to display inside rows per page dropdown.'
},
{
name: "template",
type: "string",
default: "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown",
description: "Template of the paginator."
name: 'template',
type: 'string',
default: 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown',
description: 'Template of the paginator.'
},
{
name: "currentPageReportTemplate",
type: "string",
default: "({currentPage} of {totalPages})",
description: "Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords}"
name: 'currentPageReportTemplate',
type: 'string',
default: '({currentPage} of {totalPages})',
description: 'Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords}'
},
{
name: "alwaysShow",
type: "boolean",
default: "true",
description: "Whether to show the paginator even there is only one page."
name: 'alwaysShow',
type: 'boolean',
default: 'true',
description: 'Whether to show the paginator even there is only one page.'
}
];
const PaginatorEvents = [
{
name: "page",
description: "Callback to invoke when page changes, the event object contains information about the new state.",
name: 'page',
description: 'Callback to invoke when page changes, the event object contains information about the new state.',
arguments: [
{
name: "event.page",
type: "number",
description: "New page number"
name: 'event.page',
type: 'number',
description: 'New page number'
},
{
name: "event.first",
type: "number",
description: "Index of first record"
name: 'event.first',
type: 'number',
description: 'Index of first record'
},
{
name: "event.rows",
type: "number",
description: "Number of rows to display in new page"
name: 'event.rows',
type: 'number',
description: 'Number of rows to display in new page'
},
{
name: "event.pageCount",
type: "number",
description: "Total number of pages"
name: 'event.pageCount',
type: 'number',
description: 'Total number of pages'
}
]
}
@ -80,19 +80,19 @@ const PaginatorEvents = [
const PaginatorSlots = [
{
name: "left",
name: 'left',
description: "Custom content for the component's left side"
},
{
name: "right",
name: 'right',
description: "Custom content for the component's right side"
}
];
module.exports = {
paginator: {
name: "Paginator",
description: "Paginator is a generic component to display content in paged format.",
name: 'Paginator',
description: 'Paginator is a generic component to display content in paged format.',
props: PaginatorProps,
events: PaginatorEvents,
slots: PaginatorSlots

56
api-generator/components/panel.js
View File

@ -1,44 +1,44 @@
const PanelProps = [
{
name: "header",
type: "string",
default: "null",
description: "Header text of the panel."
name: 'header',
type: 'string',
default: 'null',
description: 'Header text of the panel.'
},
{
name: "toggleable",
type: "boolean",
default: "null",
description: "Defines if content of panel can be expanded and collapsed."
name: 'toggleable',
type: 'boolean',
default: 'null',
description: 'Defines if content of panel can be expanded and collapsed.'
},
{
name: "collapsed",
type: "boolean",
default: "null",
description: "Defines the initial state of panel content."
name: 'collapsed',
type: 'boolean',
default: 'null',
description: 'Defines the initial state of panel content.'
},
{
name: "toggleButtonProps",
type: "string",
default: "null",
description: "Uses to pass the custom value to read for the anchor inside the component."
name: 'toggleButtonProps',
type: 'string',
default: 'null',
description: 'Uses to pass the custom value to read for the anchor inside the component.'
}
];
const PanelEvents = [
{
name: "toggle",
description: "Callback to invoke when a tab toggle.",
name: 'toggle',
description: 'Callback to invoke when a tab toggle.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "boolean",
description: "collapsed state as a boolean"
name: 'event.value',
type: 'boolean',
description: 'collapsed state as a boolean'
}
]
}
@ -46,19 +46,19 @@ const PanelEvents = [
const PanelSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "icons",
name: 'icons',
description: "Custom content for the header's icon"
}
];
module.exports = {
panel: {
name: "Panel",
description: "Panel is a container with the optional content toggle feature.",
name: 'Panel',
description: 'Panel is a container with the optional content toggle feature.',
props: PanelProps,
events: PanelEvents,
slots: PanelSlots

30
api-generator/components/panelmenu.js
View File

@ -1,35 +1,35 @@
const PanelMenuProps = [
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "expandedKeys",
type: "object",
default: "null",
description: "A map of keys to represent the expansion state in controlled mode."
name: 'expandedKeys',
type: 'object',
default: 'null',
description: 'A map of keys to represent the expansion state in controlled mode.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const PanelMenuSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
panelmenu: {
name: "PanelMenu",
description: "PanelMenu is a hybrid of Accordion and Tree components",
name: 'PanelMenu',
description: 'PanelMenu is a hybrid of Accordion and Tree components',
props: PanelMenuProps,
slots: PanelMenuSlots
}

194
api-generator/components/password.js
View File

@ -1,163 +1,163 @@
const PasswordProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "promptLabel",
type: "string",
default: "null",
description: "Text to prompt password entry. Defaults to PrimeVue Locale configuration."
name: 'promptLabel',
type: 'string',
default: 'null',
description: 'Text to prompt password entry. Defaults to PrimeVue Locale configuration.'
},
{
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."
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.'
},
{
name: "strongRegex",
type: "string",
default: "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})",
description: "Regex for a strong level password."
name: 'strongRegex',
type: 'string',
default: '^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})',
description: 'Regex for a strong level password.'
},
{
name: "weakLabel",
type: "string",
default: "null",
description: "Text for a weak password. Defaults to PrimeVue Locale configuration."
name: 'weakLabel',
type: 'string',
default: 'null',
description: 'Text for a weak password. Defaults to PrimeVue Locale configuration.'
},
{
name: "mediumLabel",
type: "string",
default: "null",
description: "Text for a medium password. Defaults to PrimeVue Locale configuration."
name: 'mediumLabel',
type: 'string',
default: 'null',
description: 'Text for a medium password. Defaults to PrimeVue Locale configuration.'
},
{
name: "strongLabel",
type: "string",
default: "null",
description: "Text for a strong password. Defaults to PrimeVue Locale configuration."
name: 'strongLabel',
type: 'string',
default: 'null',
description: 'Text for a strong password. Defaults to PrimeVue Locale configuration.'
},
{
name: "feedback",
type: "boolean",
default: "true",
description: "Whether to show the strength indicator or not."
name: 'feedback',
type: 'boolean',
default: 'true',
description: 'Whether to show the strength indicator or not.'
},
{
name: "toogleMask",
type: "boolean",
default: "false",
description: "Whether to show an icon to display the password as plain text."
name: 'toogleMask',
type: 'boolean',
default: 'false',
description: 'Whether to show an icon to display the password as plain text.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
name: "hideIcon",
type: "string",
default: "pi pi-eye-slash",
description: "Icon to hide displaying the password as plain text."
name: 'hideIcon',
type: 'string',
default: 'pi pi-eye-slash',
description: 'Icon to hide displaying the password as plain text.'
},
{
name: "showIcon",
type: "string",
default: "pi pi-eye",
description: "Icon to show displaying the password as plain text."
name: 'showIcon',
type: 'string',
default: 'pi pi-eye',
description: 'Icon to show displaying the password as plain text.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Placeholder text for the input."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Placeholder text for the input.'
},
{
name: "required",
type: "boolean",
default: "false",
description: "When present, it specifies that an input field must be filled out before submitting the form."
name: 'required',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that an input field must be filled out before submitting the form.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "any",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'any',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
},
{
name: "panelId",
type: "string",
default: "null",
description: "Identifier of the underlying overlay panel element."
name: 'panelId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying overlay panel element.'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "panelStyle",
type: "string",
default: "null",
description: "Inline style of the overlay panel."
name: 'panelStyle',
type: 'string',
default: 'null',
description: 'Inline style of the overlay panel.'
},
{
name: "panelProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component."
name: 'panelProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
}
];
const PasswordSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "content",
description: "Custom content for the component"
name: 'content',
description: 'Custom content for the component'
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
}
];
module.exports = {
password: {
name: "Password",
description: "Password displays strength indicator for password fields.",
name: 'Password',
description: 'Password displays strength indicator for password fields.',
props: PasswordProps,
slots: PasswordSlots
}

223
api-generator/components/picklist.js
View File

@ -1,170 +1,171 @@
const PickListProps = [
{
name: "modelValue",
type: "array",
default: "null",
description: "Value of the component as a multidimensional array."
name: 'modelValue',
type: 'array',
default: 'null',
description: 'Value of the component as a multidimensional array.'
},
{
name: "selection",
type: "array",
default: "null",
description: "Selected items in the list as a multidimensional array."
name: 'selection',
type: 'array',
default: 'null',
description: 'Selected items in the list as a multidimensional array.'
},
{
name: "metaKeySelection",
type: "boolean",
default: "true",
description: "Defines whether metaKey is requred or not for the selection. 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: 'metaKeySelection',
type: 'boolean',
default: 'true',
description:
'Defines whether metaKey is requred or not for the selection. 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: "dataKey",
type: "string",
default: "null",
description: "Name of the field that uniquely identifies the a record in the data."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'Name of the field that uniquely identifies the a record in the data.'
},
{
name: "listStyle",
type: "object",
default: "null",
description: "Inline style of the the list element."
name: 'listStyle',
type: 'object',
default: 'null',
description: 'Inline style of the the list element.'
},
{
name: "responsive",
type: "boolean",
default: "true",
description: "Whether the list optimizes layout based on screen size."
name: 'responsive',
type: 'boolean',
default: 'true',
description: 'Whether the list optimizes layout based on screen size.'
},
{
name: "breakpoint",
type: "string",
default: "960px",
description: "The breakpoint to define the maximum width boundary when responsiveness is enabled."
name: 'breakpoint',
type: 'string',
default: '960px',
description: 'The breakpoint to define the maximum width boundary when responsiveness is enabled.'
},
{
name: "stripedRows",
type: "boolean",
default: "false",
description: "Whether to displays rows with alternating colors."
name: 'stripedRows',
type: 'boolean',
default: 'false',
description: 'Whether to displays rows with alternating colors.'
},
{
name: "showSourceControls",
type: "boolean",
default: "true",
description: "Whether to show buttons of source list."
name: 'showSourceControls',
type: 'boolean',
default: 'true',
description: 'Whether to show buttons of source list.'
},
{
name: "showTargetControls",
type: "boolean",
default: "true",
description: "Whether to show buttons of target list."
name: 'showTargetControls',
type: 'boolean',
default: 'true',
description: 'Whether to show buttons of target list.'
}
];
const PickListEvents = [
{
name: "reorder",
description: "Callback to invoke when the list is reordered.",
name: 'reorder',
description: 'Callback to invoke when the list is reordered.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "array",
description: "Ordered list"
name: 'event.value',
type: 'array',
description: 'Ordered list'
},
{
name: "event.direction",
type: "string",
name: 'event.direction',
type: 'string',
description: 'Direction of the change; "up", "down", "bottom", "top"'
},
{
name: "event.listIndex",
type: "number",
description: "Index of the list that is ordered, 0 represents the source and 1 represents the target list."
name: 'event.listIndex',
type: 'number',
description: 'Index of the list that is ordered, 0 represents the source and 1 represents the target list.'
}
]
},
{
name: "move-to-target",
description: "Callback to invoke when one or more items are moved to the target list.",
name: 'move-to-target',
description: 'Callback to invoke when one or more items are moved to the target list.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.items",
type: "object",
description: "Moved items"
name: 'event.items',
type: 'object',
description: 'Moved items'
}
]
},
{
name: "move-all-to-target",
description: "Callback to invoke when all items are moved to the target list.",
name: 'move-all-to-target',
description: 'Callback to invoke when all items are moved to the target list.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.items",
type: "object",
description: "Moved items"
name: 'event.items',
type: 'object',
description: 'Moved items'
}
]
},
{
name: "move-to-source",
description: "Callback to invoke when one or more items are moved to the source list.",
name: 'move-to-source',
description: 'Callback to invoke when one or more items are moved to the source list.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.items",
type: "object",
description: "Moved items"
name: 'event.items',
type: 'object',
description: 'Moved items'
}
]
},
{
name: "move-all-to-source",
description: "Callback to invoke when all items are moved to the source list.",
name: 'move-all-to-source',
description: 'Callback to invoke when all items are moved to the source list.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.items",
type: "object",
description: "Moved items"
name: 'event.items',
type: 'object',
description: 'Moved items'
}
]
},
{
name: "selection-change",
description: "Callback to invoke when one or more items are moved to the other list.",
name: 'selection-change',
description: 'Callback to invoke when one or more items are moved to the other list.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "array",
description: "Selected items"
name: 'event.value',
type: 'array',
description: 'Selected items'
}
]
}
@ -172,47 +173,47 @@ const PickListEvents = [
const PickListSlots = [
{
name: "sourceheader",
name: 'sourceheader',
description: "Custom content for the component's source header"
},
{
name: "item",
description: "Custom content for the item"
name: 'item',
description: 'Custom content for the item'
},
{
name: "targetheader",
name: 'targetheader',
description: "Custom content for the component's target header"
},
{
name: "sourcecontrolsstart",
description: "Custom content before source control buttons"
name: 'sourcecontrolsstart',
description: 'Custom content before source control buttons'
},
{
name: "sourcecontrolsend",
description: "Custom content after source control buttons"
name: 'sourcecontrolsend',
description: 'Custom content after source control buttons'
},
{
name: "movecontrolsstart",
description: "Custom content before move buttons"
name: 'movecontrolsstart',
description: 'Custom content before move buttons'
},
{
name: "movecontrolsend",
description: "Custom content after move buttons"
name: 'movecontrolsend',
description: 'Custom content after move buttons'
},
{
name: "targetcontrolsstart",
description: "Custom content before target control buttons"
name: 'targetcontrolsstart',
description: 'Custom content before target control buttons'
},
{
name: "targetcontrolsend",
description: "Custom content after target control buttons"
name: 'targetcontrolsend',
description: 'Custom content after target control buttons'
}
];
module.exports = {
picklist: {
name: "PickList",
description: "PickList is used to reorder items between different lists.",
name: 'PickList',
description: 'PickList is used to reorder items between different lists.',
props: PickListProps,
events: PickListEvents,
slots: PickListSlots

18
api-generator/components/portal.js
View File

@ -1,15 +1,15 @@
const PortalProps = [
{
name: "appendTo",
type: "string",
default: "body",
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the dialog gets attached. Special keywords are "body" for document body and "self" for the element itself.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "If disabled, the Portal feature is eliminated and the content is displayed directly."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'If disabled, the Portal feature is eliminated and the content is displayed directly.'
}
];
@ -19,8 +19,8 @@ const PortalSlots = [];
module.exports = {
portal: {
name: "Portal",
description: "Portal moves its container to a specific location based on target elements. Basically it uses <Teleport> in the background.",
name: 'Portal',
description: 'Portal moves its container to a specific location based on target elements. Basically it uses <Teleport> in the background.',
props: PortalProps,
events: PortalEvents,
slots: PortalSlots

26
api-generator/components/progressbar.js
View File

@ -1,28 +1,28 @@
const ProgressbarProps = [
{
name: "value",
type: "number",
default: "null",
description: "Current value of the progress."
name: 'value',
type: 'number',
default: 'null',
description: 'Current value of the progress.'
},
{
name: "mode",
type: "string",
default: "determinate",
name: 'mode',
type: 'string',
default: 'determinate',
description: 'Defines the mode of the progress, valid values are "determinate" and "indeterminate".'
},
{
name: "showValue",
type: "boolean",
default: "true",
description: "Whether to display the progress bar value."
name: 'showValue',
type: 'boolean',
default: 'true',
description: 'Whether to display the progress bar value.'
}
];
module.exports = {
progressbar: {
name: "ProgressBar",
description: "ProgressBar is a process status indicator.",
name: 'ProgressBar',
description: 'ProgressBar is a process status indicator.',
props: ProgressbarProps
}
};

28
api-generator/components/progressspinner.js
View File

@ -1,28 +1,28 @@
const ProgressSpinnerProps = [
{
name: "strokeWidth",
type: "string",
default: "2",
description: "Width of the circle stroke."
name: 'strokeWidth',
type: 'string',
default: '2',
description: 'Width of the circle stroke.'
},
{
name: "fill",
type: "string",
default: "null",
description: "Color for the background of the circle."
name: 'fill',
type: 'string',
default: 'null',
description: 'Color for the background of the circle.'
},
{
name: "animationDuration",
type: "string",
default: "2s",
description: "Duration of the rotate animation."
name: 'animationDuration',
type: 'string',
default: '2s',
description: 'Duration of the rotate animation.'
}
];
module.exports = {
progressspinner: {
name: "ProgressSpinner",
description: "ProgressSpinner is a process status indicator",
name: 'ProgressSpinner',
description: 'ProgressSpinner is a process status indicator',
props: ProgressSpinnerProps
}
};

104
api-generator/components/radiobutton.js
View File

@ -1,86 +1,86 @@
const RadioButtonProps = [
{
name: "value",
type: "any",
default: "null",
description: "Value of the checkbox."
name: 'value',
type: 'any',
default: 'null',
description: 'Value of the checkbox.'
},
{
name: "modelValue",
type: "any",
default: "null",
description: "Value binding of the checkbox."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value binding of the checkbox.'
},
{
name: "name",
type: "string",
default: "null",
description: "Name of the input element."
name: 'name',
type: 'string',
default: 'null',
description: 'Name of the input element.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside 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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const RadioButtonEvents = [
{
name: "click",
description: "Callback to invoke on radio button click.",
name: 'click',
description: 'Callback to invoke on radio button click.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "change",
description: "Callback to invoke on radio button value change.",
name: 'change',
description: 'Callback to invoke on radio button value change.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -88,8 +88,8 @@ const RadioButtonEvents = [
module.exports = {
radiobutton: {
name: "RadioButton",
description: "RadioButton is an extension to standard radio button element with theming.",
name: 'RadioButton',
description: 'RadioButton is an extension to standard radio button element with theming.',
props: RadioButtonProps,
events: RadioButtonEvents
}

60
api-generator/components/rating.js
View File

@ -1,50 +1,50 @@
const RatingProps = [
{
name: "modelValue",
type: "number",
default: "null",
description: "Value of the rating."
name: 'modelValue',
type: 'number',
default: 'null',
description: 'Value of the rating.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "readonly",
type: "boolean",
default: "false",
description: "When present, it specifies that component is read-only."
name: 'readonly',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that component is read-only.'
},
{
name: "stars",
type: "number",
default: "5",
description: "Number of stars."
name: 'stars',
type: 'number',
default: '5',
description: 'Number of stars.'
},
{
name: "cancel",
type: "boolean",
default: "true",
description: "When specified a cancel icon is displayed to allow clearing the value."
name: 'cancel',
type: 'boolean',
default: 'true',
description: 'When specified a cancel icon is displayed to allow clearing the value.'
}
];
const RatingEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "number",
description: "Selected option value"
name: 'event.value',
type: 'number',
description: 'Selected option value'
}
]
}
@ -52,8 +52,8 @@ const RatingEvents = [
module.exports = {
rating: {
name: "rating",
description: "Rating component is a star based selection input.",
name: 'rating',
description: 'Rating component is a star based selection input.',
props: RatingProps,
events: RatingEvents
}

6
api-generator/components/ripple.js
View File

@ -1,7 +1,7 @@
module.exports = {
ripple: {
name: "Ripple",
description: "Ripple directive adds ripple effect to the host element.",
"vue-modifiers": []
name: 'Ripple',
description: 'Ripple directive adds ripple effect to the host element.',
'vue-modifiers': []
}
};

6
api-generator/components/row.js
View File

@ -1,7 +1,7 @@
module.exports = {
row: {
name: "Row",
description: "DataTable can be grouped by defining a Row component with nested columns",
"doc-url": "datatable"
name: 'Row',
description: 'DataTable can be grouped by defining a Row component with nested columns',
'doc-url': 'datatable'
}
};

12
api-generator/components/scrollpanel.js
View File

@ -1,16 +1,16 @@
const ScrollPanelProps = [
{
name: "step",
type: "number",
default: "5",
description: "Step factor to scroll the content while pressing the arrow keys."
name: 'step',
type: 'number',
default: '5',
description: 'Step factor to scroll the content while pressing the arrow keys.'
}
];
module.exports = {
scrollpanel: {
name: "ScrollPanel",
description: "ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.",
name: 'ScrollPanel',
description: 'ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.',
props: ScrollPanelProps
}
};

32
api-generator/components/scrolltop.js
View File

@ -1,34 +1,34 @@
const ScrollTopProps = [
{
name: "target",
type: "string",
default: "window",
name: 'target',
type: 'string',
default: 'window',
description: 'Target of the ScrollTop, valid values are "window" and "parent".'
},
{
name: "threshold",
type: "number",
default: "400",
description: "Defines the threshold value of the vertical scroll position of the target to toggle the visibility."
name: 'threshold',
type: 'number',
default: '400',
description: 'Defines the threshold value of the vertical scroll position of the target to toggle the visibility.'
},
{
name: "icon",
type: "string",
default: "pi pi-chevron-up",
description: "Icon to display."
name: 'icon',
type: 'string',
default: 'pi pi-chevron-up',
description: 'Icon to display.'
},
{
name: "behavior",
type: "string",
default: "smooth",
name: 'behavior',
type: 'string',
default: 'smooth',
description: 'Defines the scrolling behavi, "smooth" adds an animation and "auto" scrolls with a jump.'
}
];
module.exports = {
scrolltop: {
name: "ScrollTop",
description: "ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.",
name: 'ScrollTop',
description: 'ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.',
props: ScrollTopProps
}
};

122
api-generator/components/selectbutton.js
View File

@ -1,102 +1,102 @@
const SelectButtonProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
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: '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: '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: '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: '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: '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: '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: '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: 'unselectable',
type: 'boolean',
default: 'true',
description: 'Whether selection can be cleared.'
},
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Identifier of the underlying element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Identifier of the underlying element.'
}
];
const SelectButtonEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
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: 'event.value',
type: 'any',
description: 'Single value or an array of values that are selected.'
}
]
},
{
name: "focus",
description: "Callback to invoke on focus.",
name: 'focus',
description: 'Callback to invoke on focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke on blur.",
name: 'blur',
description: 'Callback to invoke on blur.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -104,15 +104,15 @@ const SelectButtonEvents = [
const SelectButtonSlots = [
{
name: "option",
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.",
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

78
api-generator/components/sidebar.js
View File

@ -1,76 +1,76 @@
const SidebarProps = [
{
name: "visible",
type: "boolean",
default: "false",
description: "Specifies the visibility of the dialog."
name: 'visible',
type: 'boolean',
default: 'false',
description: 'Specifies the visibility of the dialog.'
},
{
name: "position",
type: "string",
default: "left",
name: 'position',
type: 'string',
default: 'left',
description: 'Specifies the position of the sidebar, valid values are "left", "right", "top", "bottom" and "full".'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "dismissable",
type: "boolean",
default: "true",
description: "Whether clicking outside closes the panel."
name: 'dismissable',
type: 'boolean',
default: 'true',
description: 'Whether clicking outside closes the panel.'
},
{
name: "showCloseIcon",
type: "boolean",
default: "true",
description: "Whether to display a close icon inside the panel."
name: 'showCloseIcon',
type: 'boolean',
default: 'true',
description: 'Whether to display a close icon inside the panel.'
},
{
name: "modal",
type: "boolean",
default: "true",
description: "Whether to a modal layer behind the sidebar."
name: 'modal',
type: 'boolean',
default: 'true',
description: 'Whether to a modal layer behind the sidebar.'
},
{
name: "ariaCloseLabel",
type: "string",
default: "close",
description: "Aria label of the close icon."
name: 'ariaCloseLabel',
type: 'string',
default: 'close',
description: 'Aria label of the close icon.'
}
];
const SidebarEvents = [
{
name: "hide",
description: "Callback to invoke when sidebar gets hidden."
name: 'hide',
description: 'Callback to invoke when sidebar gets hidden.'
},
{
name: "show",
description: "Callback to invoke when sidebar gets shown."
name: 'show',
description: 'Callback to invoke when sidebar gets shown.'
}
];
const SidebarSlots = [
{
name: "header",
description: "Custom content for the component header."
name: 'header',
description: 'Custom content for the component header.'
}
];
module.exports = {
sidebar: {
name: "Sidebar",
description: "Sidebar is a panel component displayed as an overlay at the edges of the screen.",
name: 'Sidebar',
description: 'Sidebar is a panel component displayed as an overlay at the edges of the screen.',
props: SidebarProps,
events: SidebarEvents,
slots: SidebarSlots

48
api-generator/components/skeleton.js
View File

@ -1,46 +1,46 @@
const SkeletonProps = [
{
name: "shape",
type: "string",
default: "rectangle",
name: 'shape',
type: 'string',
default: 'rectangle',
description: 'Shape of the element, options are "rectangle" and "circle".'
},
{
name: "size",
type: "string",
default: "null",
description: "Size of the Circle or Square."
name: 'size',
type: 'string',
default: 'null',
description: 'Size of the Circle or Square.'
},
{
name: "width",
type: "string",
default: "100%",
description: "Width of the element."
name: 'width',
type: 'string',
default: '100%',
description: 'Width of the element.'
},
{
name: "height",
type: "string",
default: "1rem",
description: "Height of the element."
name: 'height',
type: 'string',
default: '1rem',
description: 'Height of the element.'
},
{
name: "borderRadius",
type: "string",
default: "null",
description: "Border radius of the element, defaults to value from theme."
name: 'borderRadius',
type: 'string',
default: 'null',
description: 'Border radius of the element, defaults to value from theme.'
},
{
name: "animation",
type: "string",
default: "wave",
name: 'animation',
type: 'string',
default: 'wave',
description: 'Type of the animation, valid options are "wave" and "none".'
}
];
module.exports = {
skeleton: {
name: "Skeleton",
description: "Skeleton is a placeholder to display instead of the actual content.",
name: 'Skeleton',
description: 'Skeleton is a placeholder to display instead of the actual content.',
props: SkeletonProps
}
};

110
api-generator/components/slider.js
View File

@ -1,91 +1,91 @@
const SliderProps = [
{
name: "modelValue",
type: "number",
default: "0",
description: "Value of the component."
name: 'modelValue',
type: 'number',
default: '0',
description: 'Value of the component.'
},
{
name: "min",
type: "number",
default: "0",
description: "Mininum boundary value."
name: 'min',
type: 'number',
default: '0',
description: 'Mininum boundary value.'
},
{
name: "max",
type: "number",
default: "100",
description: "Maximum boundary value."
name: 'max',
type: 'number',
default: '100',
description: 'Maximum boundary value.'
},
{
name: "orientation",
type: "string",
default: "horizontal",
description: "Orientation of the slider, valid values are horizontal and vertical."
name: 'orientation',
type: 'string',
default: 'horizontal',
description: 'Orientation of the slider, valid values are horizontal and vertical.'
},
{
name: "step",
type: "number",
default: "1",
description: "Step factor to increment/decrement the value."
name: 'step',
type: 'number',
default: '1',
description: 'Step factor to increment/decrement the value.'
},
{
name: "range",
type: "boolean",
default: "false",
description: "When speficed, allows two boundary values to be picked."
name: 'range',
type: 'boolean',
default: 'false',
description: 'When speficed, allows two boundary values to be picked.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "tabindex",
type: "number",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const SliderEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "value",
type: "number",
description: "Selected option value"
name: 'value',
type: 'number',
description: 'Selected option value'
}
]
},
{
name: "slideend",
description: "Callback to invoke when slide ends.",
name: 'slideend',
description: 'Callback to invoke when slide ends.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.value",
type: "number",
description: "New value."
name: 'event.value',
type: 'number',
description: 'New value.'
}
]
}
@ -93,8 +93,8 @@ const SliderEvents = [
module.exports = {
slider: {
name: "Slider",
description: "Slider is an input component to provide a numerical input",
name: 'Slider',
description: 'Slider is an input component to provide a numerical input',
props: SliderProps,
events: SliderEvents
}

174
api-generator/components/speeddial.js
View File

@ -1,153 +1,153 @@
const SpeedDialProps = [
{
name: "model",
type: "object",
default: "any",
description: "MenuModel instance to define the action items."
name: 'model',
type: 'object',
default: 'any',
description: 'MenuModel instance to define the action items.'
},
{
name: "visible",
type: "boolean",
default: "false",
description: "Specifies the visibility of the overlay."
name: 'visible',
type: 'boolean',
default: 'false',
description: 'Specifies the visibility of the overlay.'
},
{
name: "direction",
type: "string",
default: "up",
name: 'direction',
type: 'string',
default: 'up',
description: "Specifies the opening direction of actions. Valid values are 'up', 'down', 'left', 'right', 'up-left', 'up-right', 'down-left' and 'down-right'"
},
{
name: "transitionDelay",
type: "number",
default: "30",
description: "Transition delay step for each action item."
name: 'transitionDelay',
type: 'number',
default: '30',
description: 'Transition delay step for each action item.'
},
{
name: "type",
type: "string",
default: "linear",
description: "Specifies the opening type of actions."
name: 'type',
type: 'string',
default: 'linear',
description: 'Specifies the opening type of actions.'
},
{
name: "radius",
type: "number",
default: "0",
description: "Radius for *circle types."
name: 'radius',
type: 'number',
default: '0',
description: 'Radius for *circle types.'
},
{
name: "mask",
type: "boolean",
default: "false",
description: "Whether to show a mask element behind the speeddial"
name: 'mask',
type: 'boolean',
default: 'false',
description: 'Whether to show a mask element behind the speeddial'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "Whether the component is disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'Whether the component is disabled.'
},
{
name: "hideOnClickOutside",
type: "boolean",
default: "true",
description: "Whether the actions close when clicked outside."
name: 'hideOnClickOutside',
type: 'boolean',
default: 'true',
description: 'Whether the actions close when clicked outside.'
},
{
name: "buttonClass",
type: "string",
default: "null",
description: "Style class of the button element."
name: 'buttonClass',
type: 'string',
default: 'null',
description: 'Style class of the button element.'
},
{
name: "maskClass",
type: "string",
default: "null",
description: "Style class of the mask element."
name: 'maskClass',
type: 'string',
default: 'null',
description: 'Style class of the mask element.'
},
{
name: "maskStyle",
type: "object",
default: "null",
description: "Inline style of the mask element."
name: 'maskStyle',
type: 'object',
default: 'null',
description: 'Inline style of the mask element.'
},
{
name: "showIcon",
type: "string",
default: "pi pi-plus",
description: "Show icon of the button element."
name: 'showIcon',
type: 'string',
default: 'pi pi-plus',
description: 'Show icon of the button element.'
},
{
name: "hideIcon",
type: "string",
default: "null",
description: " Hide icon of the button element."
name: 'hideIcon',
type: 'string',
default: 'null',
description: ' Hide icon of the button element.'
},
{
name: "rotateAnimation",
type: "boolean",
default: "true",
description: "Defined to rotate showIcon when hideIcon is not present."
name: 'rotateAnimation',
type: 'boolean',
default: 'true',
description: 'Defined to rotate showIcon when hideIcon is not present.'
},
{
name: "class",
type: "object",
default: "null",
description: "Style class of the element."
name: 'class',
type: 'object',
default: 'null',
description: 'Style class of the element.'
},
{
name: "style",
type: "any",
default: "null",
description: "Style class of the element."
name: 'style',
type: 'any',
default: 'null',
description: 'Style class of the element.'
},
{
name: "tooltipOptions",
type: "object",
default: "null",
name: 'tooltipOptions',
type: 'object',
default: 'null',
description: "Whether to display the tooltip on items. The modifiers of tooltip can be used like an object in it. Valid keys are 'event' and 'position'."
}
];
const SpeedDialEvents = [
{
name: "click",
description: "Fired when the button element clicked.",
name: 'click',
description: 'Fired when the button element clicked.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "show",
description: "Fired when the actions are visible."
name: 'show',
description: 'Fired when the actions are visible.'
},
{
name: "hide",
description: "Fired when the actions are hidden."
},
name: 'hide',
description: 'Fired when the actions are hidden.'
}
];
const SpeedDialSlots = [
{
name: "item",
description: "Custom content for the item"
name: 'item',
description: 'Custom content for the item'
},
{
name: "toggle",
description: "toggle: toggle metadata"
name: 'toggle',
description: 'toggle: toggle metadata'
}
];
module.exports = {
speeddial: {
name: "SpeedDial",
description: "When pressed, a floating action button can display multiple primary actions that can be performed on a page.",
name: 'SpeedDial',
description: 'When pressed, a floating action button can display multiple primary actions that can be performed on a page.',
props: SpeedDialProps,
events: SpeedDialEvents,
slots: SpeedDialSlots
}
}
};

78
api-generator/components/splitbutton.js
View File

@ -1,63 +1,63 @@
const SplitButtonProps = [
{
name: "label",
type: "string",
default: "null",
description: "Text of the button."
name: 'label',
type: 'string',
default: 'null',
description: 'Text of the button.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Name of the icon."
name: 'icon',
type: 'string',
default: 'null',
description: 'Name of the icon.'
},
{
name: "model",
type: "object",
default: "null",
description: "MenuModel instance to define the overlay items."
name: 'model',
type: 'object',
default: 'null',
description: 'MenuModel instance to define the overlay items.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
name: "class",
type: "string",
default: "null",
description: "Style class of the component."
name: 'class',
type: 'string',
default: 'null',
description: 'Style class of the component.'
},
{
name: "style",
type: "any",
default: "null",
description: "Inline of the component."
name: 'style',
type: 'any',
default: 'null',
description: 'Inline of the component.'
}
];
const SplitButtonEvents = [
{
name: "click",
description: "Callback to invoke when main button is clicked.",
name: 'click',
description: 'Callback to invoke when main button is clicked.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -65,8 +65,8 @@ const SplitButtonEvents = [
module.exports = {
splitbutton: {
name: "SplitButton",
description: "SplitButton groups a set of commands in an overlay with a default command.",
name: 'SplitButton',
description: 'SplitButton groups a set of commands in an overlay with a default command.',
props: SplitButtonProps,
events: SplitButtonEvents
}

56
api-generator/components/splitter.js
View File

@ -1,50 +1,50 @@
const SplitterProps = [
{
name: "layout",
type: "string",
default: "horizontal",
name: 'layout',
type: 'string',
default: 'horizontal',
description: 'Orientation of the panels, valid values are "horizontal" and "vertical".'
},
{
name: "gutterSize",
type: "number",
default: "4",
description: "Size of the divider in pixels."
name: 'gutterSize',
type: 'number',
default: '4',
description: 'Size of the divider in pixels.'
},
{
name: "stateKey",
type: "string",
default: "null",
description: "Storage identifier of a stateful Splitter."
name: 'stateKey',
type: 'string',
default: 'null',
description: 'Storage identifier of a stateful Splitter.'
},
{
name: "stateStorage",
type: "string",
default: "storage",
name: 'stateStorage',
type: 'string',
default: 'storage',
description: 'Defines where a stateful splitter keeps its state, valid values are "session" for sessionStorage and "local" for localStorage.'
},
{
name: "step",
type: "number",
default: "5",
description: "Step factor to increment/decrement the size of the panels while pressing the arrow keys."
name: 'step',
type: 'number',
default: '5',
description: 'Step factor to increment/decrement the size of the panels while pressing the arrow keys.'
}
];
const SplitterEvents = [
{
name: "resizened",
description: "Callback to invoke when resize ends.",
name: 'resizened',
description: 'Callback to invoke when resize ends.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Browser event"
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
name: "event.sizes",
type: "array",
description: "Sizes of the panels as an array"
name: 'event.sizes',
type: 'array',
description: 'Sizes of the panels as an array'
}
]
}
@ -52,8 +52,8 @@ const SplitterEvents = [
module.exports = {
splitter: {
name: "Splitter",
description: "Splitter is utilized to separate and resize panels",
name: 'Splitter',
description: 'Splitter is utilized to separate and resize panels',
props: SplitterProps,
events: SplitterEvents
}

22
api-generator/components/splitterpanel.js
View File

@ -1,23 +1,23 @@
const SplitterPanelProps = [
{
name: "size",
type: "number",
default: "null",
description: "Size of the element relative to 100%."
name: 'size',
type: 'number',
default: 'null',
description: 'Size of the element relative to 100%.'
},
{
name: "minSize",
type: "number",
default: "null",
description: "Minimum size of the element relative to 100%."
name: 'minSize',
type: 'number',
default: 'null',
description: 'Minimum size of the element relative to 100%.'
}
];
module.exports = {
splitterpanel: {
name: "SplitterPanel",
description: "Splitter requires two SplitterPanel components to wrap.",
"doc-url": "splitter",
name: 'SplitterPanel',
description: 'Splitter requires two SplitterPanel components to wrap.',
'doc-url': 'splitter',
props: SplitterPanelProps
}
};

38
api-generator/components/steps.js
View File

@ -1,41 +1,41 @@
const StepsProps = [
{
name: "id",
type: "string",
default: "null",
description: "Unique identifier of the element."
name: 'id',
type: 'string',
default: 'null',
description: 'Unique identifier of the element.'
},
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "readonly",
type: "boolean",
default: "true",
description: "Whether the items are clickable or not."
name: 'readonly',
type: 'boolean',
default: 'true',
description: 'Whether the items are clickable or not.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const StepsSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
steps: {
name: "steps",
description: "Steps components is an indicator for the steps in a wizard workflow.",
name: 'steps',
description: 'Steps components is an indicator for the steps in a wizard workflow.',
props: StepsProps,
slots: StepsSlots
}

8
api-generator/components/styleclass.js
View File

@ -1,7 +1,7 @@
module.exports = {
styleclass: {
name: "StyleClass",
description: "StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.",
"vue-modifiers": []
name: 'StyleClass',
description: 'StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.',
'vue-modifiers': []
}
};
};

48
api-generator/components/tabmenu.js
View File

@ -1,38 +1,38 @@
const TabMenuProps = [
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "exact",
type: "boolean",
default: "true",
description: "Defines if active route highlight should match the exact route path."
name: 'exact',
type: 'boolean',
default: 'true',
description: 'Defines if active route highlight should match the exact route path.'
},
{
name: "activeIndex",
type: "number",
default: "0",
description: "Active index of menuitem."
name: 'activeIndex',
type: 'number',
default: '0',
description: 'Active index of menuitem.'
}
];
const TabMenuEvents = [
{
name: "tab-change",
description: "Callback to invoke when an active tab is changed.",
name: 'tab-change',
description: 'Callback to invoke when an active tab is changed.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.index",
type: "number",
description: "Index of the selected tab"
name: 'event.index',
type: 'number',
description: 'Index of the selected tab'
}
]
}
@ -40,15 +40,15 @@ const TabMenuEvents = [
const TabMenuSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
tabmenu: {
name: "TabMenu",
description: "TabMenu is a navigation component that displays items as tab headers.",
name: 'TabMenu',
description: 'TabMenu is a navigation component that displays items as tab headers.',
props: TabMenuProps,
events: TabMenuEvents,
slots: TabMenuSlots

110
api-generator/components/tabpanel.js
View File

@ -1,90 +1,90 @@
const TabPanelProps = [
{
name: "header",
type: "string",
default: "null",
description: "Orientation of tab headers."
name: 'header',
type: 'string',
default: 'null',
description: 'Orientation of tab headers.'
},
{
name: "headerStyle",
type: "any",
default: "null",
description: "Inline style of the tab header."
name: 'headerStyle',
type: 'any',
default: 'null',
description: 'Inline style of the tab header.'
},
{
name: "headerClass",
type: "any",
default: "null",
description: "Style class of the tab header."
name: 'headerClass',
type: 'any',
default: 'null',
description: 'Style class of the tab header.'
},
{
name: "headerProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLLiElement to the tab header."
name: 'headerProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLLiElement to the tab header.'
},
{
name: "headerActionProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header."
name: 'headerActionProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.'
},
{
name: "contentStyle",
type: "any",
default: "null",
description: "Inline style of the tab content."
name: 'contentStyle',
type: 'any',
default: 'null',
description: 'Inline style of the tab content.'
},
{
name: "contentClass",
type: "any",
default: "null",
description: "Style class of the tab content."
name: 'contentClass',
type: 'any',
default: 'null',
description: 'Style class of the tab content.'
},
{
name: "contentProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLDivElement to the tab content."
name: 'contentProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLDivElement to the tab content.'
},
{
name: "disabled",
type: "boolean",
default: "null",
description: "Whether the tab is disabled."
name: 'disabled',
type: 'boolean',
default: 'null',
description: 'Whether the tab is disabled.'
}
];
const TabPanelEvents = [
{
name: "tab-change",
description: "Callback to invoke when an active tab is changed.",
name: 'tab-change',
description: 'Callback to invoke when an active tab is changed.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.index",
type: "number",
description: "Index of the selected tab"
name: 'event.index',
type: 'number',
description: 'Index of the selected tab'
}
]
},
{
name: "tab-click",
description: "Callback to invoke when an active tab is clicked.",
name: 'tab-click',
description: 'Callback to invoke when an active tab is clicked.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.index",
type: "number",
description: "Index of the selected tab"
name: 'event.index',
type: 'number',
description: 'Index of the selected tab'
}
]
}
@ -92,9 +92,9 @@ const TabPanelEvents = [
module.exports = {
tabpanel: {
name: "TabPanel",
description: "TabView element consists of one or more TabPanel elements.",
"doc-url": "tabview",
name: 'TabPanel',
description: 'TabView element consists of one or more TabPanel elements.',
'doc-url': 'tabview',
props: TabPanelProps,
events: TabPanelEvents
}

92
api-generator/components/tabview.js
View File

@ -1,78 +1,78 @@
const TabViewProps = [
{
name: "activeIndex",
type: "number",
default: "0",
description: "Index of the active tab."
name: 'activeIndex',
type: 'number',
default: '0',
description: 'Index of the active tab.'
},
{
name: "lazy",
type: "boolean",
default: "false",
description: "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css."
name: 'lazy',
type: 'boolean',
default: 'false',
description: 'When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css.'
},
{
name: "scrollable",
type: "boolean",
default: "false",
description: "When enabled displays buttons at each side of the tab headers to scroll the tab list."
name: 'scrollable',
type: 'boolean',
default: 'false',
description: 'When enabled displays buttons at each side of the tab headers to scroll the tab list.'
},
{
name: "tabindex",
type: "number",
default: "0",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: '0',
description: 'Index of the element in tabbing order.'
},
{
name: "selectOnFocus",
type: "boolean",
default: "false",
description: "When enabled, the focused tab is activated."
name: 'selectOnFocus',
type: 'boolean',
default: 'false',
description: 'When enabled, the focused tab is activated.'
},
{
name: "previousButtonProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLButtonElement to the previous button."
name: 'previousButtonProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLButtonElement to the previous button.'
},
{
name: "nextButtonProps",
type: "any",
default: "null",
description: "Uses to pass all properties of the HTMLButtonElement to the next button."
name: 'nextButtonProps',
type: 'any',
default: 'null',
description: 'Uses to pass all properties of the HTMLButtonElement to the next button.'
}
];
const TabViewEvents = [
{
name: "tab-change",
description: "Callback to invoke when an active tab is changed.",
name: 'tab-change',
description: 'Callback to invoke when an active tab is changed.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "index",
type: "number",
description: "Index of the selected tab"
name: 'index',
type: 'number',
description: 'Index of the selected tab'
}
]
},
{
name: "tab-click",
description: "Callback to invoke when an active tab is clicked.",
name: 'tab-click',
description: 'Callback to invoke when an active tab is clicked.',
arguments: [
{
name: "originalEvent",
type: "object",
description: "Original event"
name: 'originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "index",
type: "number",
description: "Index of the clicked tab"
name: 'index',
type: 'number',
description: 'Index of the clicked tab'
}
]
}
@ -80,8 +80,8 @@ const TabViewEvents = [
module.exports = {
tabview: {
name: "TabView",
description: "TabView is a container component to group content with tabs.",
name: 'TabView',
description: 'TabView is a container component to group content with tabs.',
props: TabViewProps,
event: TabViewEvents
}

34
api-generator/components/tag.js
View File

@ -1,34 +1,34 @@
const TagProps = [
{
name: "value",
type: "any",
default: "null",
description: "Value to display inside the tag."
name: 'value',
type: 'any',
default: 'null',
description: 'Value to display inside the tag.'
},
{
name: "severity",
type: "string",
default: "null",
name: 'severity',
type: 'string',
default: 'null',
description: 'Severity type of the tag. Valid severities are "success", "info", "warning" and "danger".'
},
{
name: "rounded",
type: "boolean",
default: "false",
description: "Whether the corners of the tag are rounded."
name: 'rounded',
type: 'boolean',
default: 'false',
description: 'Whether the corners of the tag are rounded.'
},
{
name: "icon",
type: "string",
default: "null",
description: "Icon of the tag to display next to the value."
name: 'icon',
type: 'string',
default: 'null',
description: 'Icon of the tag to display next to the value.'
}
];
module.exports = {
tag: {
name: "Tag",
description: "Tag component is used to categorize content.",
name: 'Tag',
description: 'Tag component is used to categorize content.',
props: TagProps
}
};

20
api-generator/components/terminal.js
View File

@ -1,22 +1,22 @@
const TerminalProps = [
{
name: "welcomeMessage",
type: "string",
default: "null",
description: "Initial text to display on terminal."
name: 'welcomeMessage',
type: 'string',
default: 'null',
description: 'Initial text to display on terminal.'
},
{
name: "prompt",
type: "string",
default: "null",
description: "Prompt text for each command."
name: 'prompt',
type: 'string',
default: 'null',
description: 'Prompt text for each command.'
}
];
module.exports = {
terminal: {
name: "Terminal",
description: "Terminal is a text based user interface.",
name: 'Terminal',
description: 'Terminal is a text based user interface.',
props: TerminalProps
}
};

20
api-generator/components/textarea.js
View File

@ -1,22 +1,22 @@
const TextareaProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "autoResize",
type: "boolean",
default: "false",
description: "When present, height of textarea changes as being typed."
name: 'autoResize',
type: 'boolean',
default: 'false',
description: 'When present, height of textarea changes as being typed.'
}
];
module.exports = {
textarea: {
name: "Textarea",
description: "Textarea is a multi-line text input element.",
name: 'Textarea',
description: 'Textarea is a multi-line text input element.',
props: TextareaProps
}
};

54
api-generator/components/tieredmenu.js
View File

@ -1,53 +1,53 @@
const TieredMenuProps = [
{
name: "model",
type: "array",
default: "null",
description: "An array of menuitems."
name: 'model',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
name: "popup",
type: "boolean",
default: "false",
description: "Defines if menu would displayed as a popup."
name: 'popup',
type: 'boolean',
default: 'false',
description: 'Defines if menu would displayed as a popup.'
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "exact",
type: "boolean",
default: "true",
name: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
}
];
const TieredMenuSlots = [
{
name: "item",
description: "Template of a menuitem."
name: 'item',
description: 'Template of a menuitem.'
}
];
module.exports = {
tieredmenu: {
name: "TieredMenu",
description: "TieredMenu displays submenus in nested overlays.",
name: 'TieredMenu',
description: 'TieredMenu displays submenus in nested overlays.',
props: TieredMenuProps,
slots: TieredMenuSlots
}

48
api-generator/components/timeline.js
View File

@ -1,53 +1,53 @@
const TimelineProps = [
{
name: "value",
type: "array",
default: "null",
description: "An array of events to display."
name: 'value',
type: 'array',
default: 'null',
description: 'An array of events to display.'
},
{
name: "align",
type: "string",
default: "left",
name: 'align',
type: 'string',
default: 'left',
description: 'Position of the timeline bar relative to the content. Valid values are "left", "right" and "alternate" for vertical layout and "top", "bottom" for horizontal layout.'
},
{
name: "layout",
type: "string",
default: "vertical",
name: 'layout',
type: 'string',
default: 'vertical',
description: 'Orientation of the timeline, valid values are "vertical" and "horizontal".'
},
{
name: "dataKey",
type: "string",
default: "null",
description: "Name of the field that uniquely identifies the a record in the data."
name: 'dataKey',
type: 'string',
default: 'null',
description: 'Name of the field that uniquely identifies the a record in the data.'
}
];
const TimelineSlots = [
{
name: "opposite",
description: "Custom content for the content to be placed at the other side of the bar"
name: 'opposite',
description: 'Custom content for the content to be placed at the other side of the bar'
},
{
name: "marker",
description: "Custom content for the marker"
name: 'marker',
description: 'Custom content for the marker'
},
{
name: "content",
description: "Custom content"
name: 'content',
description: 'Custom content'
},
{
name: "connector",
description: "Connector element"
name: 'connector',
description: 'Connector element'
}
];
module.exports = {
timeline: {
name: "Timeline",
description: "Timeline visualizes a series of chained events.",
name: 'Timeline',
description: 'Timeline visualizes a series of chained events.',
props: TimelineProps,
slots: TimelineSlots
}

46
api-generator/components/toast.js
View File

@ -1,47 +1,47 @@
const ToastProps = [
{
name: "group",
type: "string",
default: "null",
description: "Unique identifier of a message group."
name: 'group',
type: 'string',
default: 'null',
description: 'Unique identifier of a message group.'
},
{
name: "position",
type: "string",
default: "top-right",
name: 'position',
type: 'string',
default: 'top-right',
description: 'Position of the toast in viewport. Other valid values are "top-left", "top-center", "bottom-left", "bottom-center", "bottom-right" and "center".'
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
name: "breakpoints",
type: "object",
default: "null",
description: "Object literal to define widths per screen size."
name: 'breakpoints',
type: 'object',
default: 'null',
description: 'Object literal to define widths per screen size.'
}
];
const ToastSlots = [
{
name: "message",
description: "Custom content for the toast message"
name: 'message',
description: 'Custom content for the toast message'
}
];
module.exports = {
toast: {
name: "Toast",
description: "Toast is used to display messages in an overlay.",
name: 'Toast',
description: 'Toast is used to display messages in an overlay.',
props: ToastProps,
slots: ToastSlots
}

128
api-generator/components/togglebutton.js
View File

@ -1,109 +1,109 @@
const ToggleButtonProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "onIcon",
type: "string",
default: "null",
description: "Icon for the on state."
name: 'onIcon',
type: 'string',
default: 'null',
description: 'Icon for the on state.'
},
{
name: "offIcon",
type: "string",
default: "null",
description: "Icon for the off state."
name: 'offIcon',
type: 'string',
default: 'null',
description: 'Icon for the off state.'
},
{
name: "onLabel",
type: "string",
default: "yes",
description: "Label for the on state."
name: 'onLabel',
type: 'string',
default: 'yes',
description: 'Label for the on state.'
},
{
name: "offLabel",
type: "string",
default: "no",
description: "Label for the off state."
name: 'offLabel',
type: 'string',
default: 'no',
description: 'Label for the off state.'
},
{
name: "iconPos",
type: "string",
default: "left",
name: 'iconPos',
type: 'string',
default: 'left',
description: 'Position of the icon, valid values are "left" and "right".'
},
{
name: "tabindex",
type: "number",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'number',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the element should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the element should be disabled.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the focus input to match a label defined for the chips."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the focus input to match a label defined for the chips.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputProps",
type: "object",
default: "null",
description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component."
name: 'inputProps',
type: 'object',
default: 'null',
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
}
];
const ToggleButtonEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "focus",
description: "Callback to invoke when the component receives focus.",
name: 'focus',
description: 'Callback to invoke when the component receives focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
},
{
name: "blur",
description: "Callback to invoke when the component loses focus.",
name: 'blur',
description: 'Callback to invoke when the component loses focus.',
arguments: [
{
name: "event",
type: "object",
description: "Browser event"
name: 'event',
type: 'object',
description: 'Browser event'
}
]
}
@ -111,8 +111,8 @@ const ToggleButtonEvents = [
module.exports = {
togglebutton: {
name: "ToggleButton",
description: "ToggleButton is used to select a boolean value using a button.",
name: 'ToggleButton',
description: 'ToggleButton is used to select a boolean value using a button.',
props: ToggleButtonProps,
events: ToggleButtonEvents
}

16
api-generator/components/toolbar.js
View File

@ -1,27 +1,27 @@
const ToolbarProps = [
{
name: "aria-labelledby",
type: "string",
default: "null",
description: "Defines a string value that labels an interactive element."
name: 'aria-labelledby',
type: 'string',
default: 'null',
description: 'Defines a string value that labels an interactive element.'
}
];
const ToolbarSlots = [
{
name: "start",
name: 'start',
description: "Custom content for the component's left side"
},
{
name: "end",
name: 'end',
description: "Custom content for the component's right side"
}
];
module.exports = {
toolbar: {
name: "Toolbar",
description: "Toolbar is a grouping component for buttons and other content.",
name: 'Toolbar',
description: 'Toolbar is a grouping component for buttons and other content.',
props: ToolbarProps,
slots: ToolbarSlots
}

30
api-generator/components/tooltip.js
View File

@ -1,34 +1,34 @@
const TooltipModifiers = [
{
name: "right",
description: "Positions the tooltip on the right of the trigger element (default)"
name: 'right',
description: 'Positions the tooltip on the right of the trigger element (default)'
},
{
name: "top",
description: "Positions the tooltip on the top of the trigger element"
name: 'top',
description: 'Positions the tooltip on the top of the trigger element'
},
{
name: "bottom",
description: "Positions the tooltip on the bottom of the trigger element"
name: 'bottom',
description: 'Positions the tooltip on the bottom of the trigger element'
},
{
name: "left",
description: "Positions the tooltip on the left of the trigger element"
name: 'left',
description: 'Positions the tooltip on the left of the trigger element'
},
{
name: "focus",
description: "Focus on the trigger element"
name: 'focus',
description: 'Focus on the trigger element'
},
{
name: "blur",
description: "Blur the trigger element"
name: 'blur',
description: 'Blur the trigger element'
}
];
module.exports = {
tooltip: {
name: "Tooltip",
description: "Tooltip directive provides advisory information for a component.",
"vue-modifiers": TooltipModifiers
name: 'Tooltip',
description: 'Tooltip directive provides advisory information for a component.',
'vue-modifiers': TooltipModifiers
}
};

141
api-generator/components/tree.js
View File

@ -1,126 +1,127 @@
const TreeProps = [
{
name: "value",
type: "any",
default: "null",
description: "An array of treenodes."
name: 'value',
type: 'any',
default: 'null',
description: 'An array of treenodes.'
},
{
name: "expandedKeys",
type: "array",
default: "null",
description: "A map of keys to represent the expansion state in controlled mode."
name: 'expandedKeys',
type: 'array',
default: 'null',
description: 'A map of keys to represent the expansion state in controlled mode.'
},
{
name: "selectionMode",
type: "string",
default: "null",
name: 'selectionMode',
type: 'string',
default: 'null',
description: 'Defines the selection mode, valid values "single", "multiple", and "checkbox".'
},
{
name: "selectionKeys",
type: "any",
default: "null",
description: "A map of keys to control the selection state."
name: 'selectionKeys',
type: 'any',
default: 'null',
description: 'A map of keys to control the selection state.'
},
{
name: "metaKeySelection",
type: "boolean",
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."
name: 'metaKeySelection',
type: 'boolean',
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.'
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Whether to display loading indicator."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Whether to display loading indicator.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spin",
description: "Icon to display when tree is loading."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spin',
description: 'Icon to display when tree is loading.'
},
{
name: "filter",
type: "boolean",
default: "false",
description: "When specified, displays an input field to filter the items."
name: 'filter',
type: 'boolean',
default: 'false',
description: 'When specified, displays an input field to filter the items.'
},
{
name: "filterBy",
type: "string",
default: "label",
description: "When filtering is enabled, filterBy decides which field or fields (comma separated) to search against."
name: 'filterBy',
type: 'string',
default: 'label',
description: 'When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.'
},
{
name: "filterMode",
type: "string",
default: "lenient",
name: 'filterMode',
type: 'string',
default: 'lenient',
description: 'Mode for filtering valid values are "lenient" and "strict". Default is lenient.'
},
{
name: "filterPlaceholder",
type: "string",
default: "null",
description: "Placeholder text to show when filter input is empty."
name: 'filterPlaceholder',
type: 'string',
default: 'null',
description: 'Placeholder text to show when filter input is empty.'
},
{
name: "filterLocale",
type: "string",
default: "undefined",
name: 'filterLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in filtering. The default locale is the host environment's current locale."
},
{
name: "scrollHeight",
type: "string",
default: "null",
name: 'scrollHeight',
type: 'string',
default: 'null',
description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.'
}
];
const TreeEvents = [
{
name: "node-select",
description: "Callback to invoke when a node is selected.",
name: 'node-select',
description: 'Callback to invoke when a node is selected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-unselect",
description: "Callback to invoke when a node is unselected.",
name: 'node-unselect',
description: 'Callback to invoke when a node is unselected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-expand",
description: "Callback to invoke when a node is expanded.",
name: 'node-expand',
description: 'Callback to invoke when a node is expanded.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-collapse",
description: "Callback to invoke when a node is collapsed.",
name: 'node-collapse',
description: 'Callback to invoke when a node is collapsed.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
}
@ -128,8 +129,8 @@ const TreeEvents = [
module.exports = {
tree: {
name: "Tree",
description: "Tree is used to display hierarchical data.",
name: 'Tree',
description: 'Tree is used to display hierarchical data.',
props: TreeProps,
events: TreeEvents
}

215
api-generator/components/treeselect.js
View File

@ -1,177 +1,178 @@
const TreeSelectProps = [
{
name: "modelValue",
type: "any",
default: "null",
description: "Value of the component."
name: 'modelValue',
type: 'any',
default: 'null',
description: 'Value of the component.'
},
{
name: "options",
type: "array",
default: "null",
description: "An array of treenodes."
name: 'options',
type: 'array',
default: 'null',
description: 'An array of treenodes.'
},
{
name: "scrollHeight",
type: "string",
default: "200px",
description: "Height of the viewport, a scrollbar is defined if height of list exceeds this value."
name: 'scrollHeight',
type: 'string',
default: '200px',
description: 'Height of the viewport, a scrollbar is defined if height of list exceeds this value.'
},
{
name: "placeholder",
type: "string",
default: "null",
description: "Label to display when there are no selections."
name: 'placeholder',
type: 'string',
default: 'null',
description: 'Label to display when there are no selections.'
},
{
name: "disabled",
type: "boolean",
default: "false",
description: "When present, it specifies that the component should be disabled."
name: 'disabled',
type: 'boolean',
default: 'false',
description: 'When present, it specifies that the component should be disabled.'
},
{
name: "tabindex",
type: "string",
default: "null",
description: "Index of the element in tabbing order."
name: 'tabindex',
type: 'string',
default: 'null',
description: 'Index of the element in tabbing order.'
},
{
name: "inputId",
type: "string",
default: "null",
description: "Identifier of the underlying input element."
name: 'inputId',
type: 'string',
default: 'null',
description: 'Identifier of the underlying input element.'
},
{
name: "inputStyle",
type: "any",
default: "null",
description: "Inline style of the input field."
name: 'inputStyle',
type: 'any',
default: 'null',
description: 'Inline style of the input field.'
},
{
name: "inputClass",
type: "string",
default: "null",
description: "Style class of the input field."
name: 'inputClass',
type: 'string',
default: 'null',
description: 'Style class of the input field.'
},
{
name: "selectionMode",
type: "string",
default: "null",
name: 'selectionMode',
type: 'string',
default: 'null',
description: 'Defines the selection mode, valid values "single", "multiple", and "checkbox".'
},
{
name: "panelClass",
type: "string",
default: "null",
description: "Style class of the overlay panel."
name: 'panelClass',
type: 'string',
default: 'null',
description: 'Style class of the overlay panel.'
},
{
name: "appendTo",
type: "string",
default: "body",
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.'
},
{
name: "emptyMessage",
type: "string",
default: "No results found",
description: "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
name: 'emptyMessage',
type: 'string',
default: 'No results found',
description: 'Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.'
},
{
name: "display",
type: "string",
default: "comma",
name: 'display',
type: 'string',
default: 'comma',
description: 'Defines how the selected items are displayed, valid values are "comma" and "chip".'
},
{
name: "metaKeySelection",
type: "boolean",
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."
name: 'metaKeySelection',
type: 'boolean',
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.'
},
{
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-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."
name: 'aria-label',
type: 'string',
default: 'null',
description: 'Used to define a string that labels the element.'
}
];
const TreeSelectEvents = [
{
name: "change",
description: "Callback to invoke on value change.",
name: 'change',
description: 'Callback to invoke on value change.',
arguments: [
{
name: "event",
type: "object",
description: "Selected node keys"
name: 'event',
type: 'object',
description: 'Selected node keys'
}
]
},
{
name: "before-show",
description: "Callback to invoke before the overlay is shown."
name: 'before-show',
description: 'Callback to invoke before the overlay is shown.'
},
{
name: "before-hide",
description: "Callback to invoke before the overlay is hidden."
name: 'before-hide',
description: 'Callback to invoke before the overlay is hidden.'
},
{
name: "show",
description: "Callback to invoke when the overlay is shown."
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
name: "hide",
description: "Callback to invoke when the overlay is hidden."
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
},
{
name: "node-select",
description: "Callback to invoke when a node is selected.",
name: 'node-select',
description: 'Callback to invoke when a node is selected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-unselect",
description: "Callback to invoke when a node is unselected.",
name: 'node-unselect',
description: 'Callback to invoke when a node is unselected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-expand",
description: "Callback to invoke when a node is expanded.",
name: 'node-expand',
description: 'Callback to invoke when a node is expanded.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-collapse",
description: "Callback to invoke when a node is collapsed.",
name: 'node-collapse',
description: 'Callback to invoke when a node is collapsed.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
}
@ -179,31 +180,31 @@ const TreeSelectEvents = [
const TreeSelectSlots = [
{
name: "value",
name: 'value',
description: "Custom content for the item's value"
},
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "indicator",
description: "Custom content for the dropdown indicator"
name: 'indicator',
description: 'Custom content for the dropdown indicator'
}
];
module.exports = {
treeselect: {
name: "TreeSelect",
description: "TreeSelect is a form component to choose from hierarchical data.",
name: 'TreeSelect',
description: 'TreeSelect is a form component to choose from hierarchical data.',
props: TreeSelectProps,
events: TreeSelectEvents,
slots: TreeSelectSlots

527
api-generator/components/treetable.js
View File

@ -1,439 +1,440 @@
const TreeTableProps = [
{
name: "value",
type: "array",
default: "null",
description: "An array of treenodes."
name: 'value',
type: 'array',
default: 'null',
description: 'An array of treenodes.'
},
{
name: "expandedKeys",
type: "array",
default: "null",
description: "A map of keys to represent the state of the tree expansion state in controlled mode."
name: 'expandedKeys',
type: 'array',
default: 'null',
description: 'A map of keys to represent the state of the tree expansion state in controlled mode.'
},
{
name: "selectionKeys",
type: "any",
default: "null",
description: "A map of keys to control the selection state."
name: 'selectionKeys',
type: 'any',
default: 'null',
description: 'A map of keys to control the selection state.'
},
{
name: "selectionMode",
type: "string",
default: "null",
name: 'selectionMode',
type: 'string',
default: 'null',
description: 'Defines the selection mode, valid values "single", "multiple", and "checkbox".'
},
{
name: "metaKeySelection",
type: "boolean",
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."
name: 'metaKeySelection',
type: 'boolean',
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.'
},
{
name: "rows",
type: "number",
default: "null",
description: "Number of rows to display per page."
name: 'rows',
type: 'number',
default: 'null',
description: 'Number of rows to display per page.'
},
{
name: "first",
type: "number",
default: "0",
description: "Index of the first row to be displayed."
name: 'first',
type: 'number',
default: '0',
description: 'Index of the first row to be displayed.'
},
{
name: "totalRecords",
type: "number",
default: "null",
description: "Number of total records, defaults to length of value when not defined."
name: 'totalRecords',
type: 'number',
default: 'null',
description: 'Number of total records, defaults to length of value when not defined.'
},
{
name: "paginator",
type: "boolean",
default: "false",
description: "When specified as true, enables the pagination."
name: 'paginator',
type: 'boolean',
default: 'false',
description: 'When specified as true, enables the pagination.'
},
{
name: "paginatorPosition",
type: "string",
default: "bottom",
name: 'paginatorPosition',
type: 'string',
default: 'bottom',
description: 'Position of the paginator, options are "top", "bottom" or "both".'
},
{
name: "alwaysShowPaginator",
type: "boolean",
default: "true",
description: "Whether to show it even there is only one page."
name: 'alwaysShowPaginator',
type: 'boolean',
default: 'true',
description: 'Whether to show it even there is only one page.'
},
{
name: "paginatorTemplate",
type: "string",
default: "FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown",
description: "Template of the paginator."
name: 'paginatorTemplate',
type: 'string',
default: 'FirstPageLink PrevPageLink PageLinks NextPageLink LastPageLink RowsPerPageDropdown',
description: 'Template of the paginator.'
},
{
name: "pageLinkSize",
type: "number",
default: "5",
description: "Number of page links to display."
name: 'pageLinkSize',
type: 'number',
default: '5',
description: 'Number of page links to display.'
},
{
name: "rowsPerPageOptions",
type: "array",
default: "null",
description: "Array of integer values to display inside rows per page dropdown."
name: 'rowsPerPageOptions',
type: 'array',
default: 'null',
description: 'Array of integer values to display inside rows per page dropdown.'
},
{
name: "currentPageReportTemplate",
type: "string",
default: "({currentPage} of {totalPages})",
description: "Template of the current page report element."
name: 'currentPageReportTemplate',
type: 'string',
default: '({currentPage} of {totalPages})',
description: 'Template of the current page report element.'
},
{
name: "lazy",
type: "boolean",
default: "false",
description: "Defines if data is loaded and interacted with in lazy manner."
name: 'lazy',
type: 'boolean',
default: 'false',
description: 'Defines if data is loaded and interacted with in lazy manner.'
},
{
name: "loading",
type: "boolean",
default: "false",
description: "Displays a loader to indicate data load is in progress."
name: 'loading',
type: 'boolean',
default: 'false',
description: 'Displays a loader to indicate data load is in progress.'
},
{
name: "loadingIcon",
type: "string",
default: "pi pi-spinner",
description: "The icon to show while indicating data load is in progress."
name: 'loadingIcon',
type: 'string',
default: 'pi pi-spinner',
description: 'The icon to show while indicating data load is in progress.'
},
{
name: "rowHover",
type: "boolean",
default: "false",
description: "When enabled, background of the rows change on hover."
name: 'rowHover',
type: 'boolean',
default: 'false',
description: 'When enabled, background of the rows change on hover.'
},
{
name: "autoLayout",
type: "boolean",
default: "false",
description: "Whether the cell widths scale according to their content or not."
name: 'autoLayout',
type: 'boolean',
default: 'false',
description: 'Whether the cell widths scale according to their content or not.'
},
{
name: "sortField",
type: "string",
default: "null",
description: "Property name or a getter function of a row data used for sorting by default."
name: 'sortField',
type: 'string',
default: 'null',
description: 'Property name or a getter function of a row data used for sorting by default.'
},
{
name: "sortOrder",
type: "number",
default: "null",
description: "Order to sort the data by default."
name: 'sortOrder',
type: 'number',
default: 'null',
description: 'Order to sort the data by default.'
},
{
name: "defaultSortOrder",
type: "number",
default: "1",
description: "Default sort order of an unsorted column."
name: 'defaultSortOrder',
type: 'number',
default: '1',
description: 'Default sort order of an unsorted column.'
},
{
name: "multiSortMeta",
type: "array",
default: "null",
description: "An array of SortMeta objects to sort the data by default in multiple sort mode."
name: 'multiSortMeta',
type: 'array',
default: 'null',
description: 'An array of SortMeta objects to sort the data by default in multiple sort mode.'
},
{
name: "sortMode",
type: "string",
default: "single",
description: "Defines whether sorting works on single column or on multiple columns."
name: 'sortMode',
type: 'string',
default: 'single',
description: 'Defines whether sorting works on single column or on multiple columns.'
},
{
name: "removableSort",
type: "boolean",
default: "false",
description: "When enabled, columns can have an un-sorted state."
name: 'removableSort',
type: 'boolean',
default: 'false',
description: 'When enabled, columns can have an un-sorted state.'
},
{
name: "filters",
type: "object",
default: "null",
description: "Filters object with key-value pairs to define the filters."
name: 'filters',
type: 'object',
default: 'null',
description: 'Filters object with key-value pairs to define the filters.'
},
{
name: "filterMode",
type: "string",
default: "lenient",
name: 'filterMode',
type: 'string',
default: 'lenient',
description: 'Mode for filtering valid values are "lenient" and "strict". Default is lenient.'
},
{
name: "filterLocale",
type: "string",
default: "undefined",
name: 'filterLocale',
type: 'string',
default: 'undefined',
description: "Locale to use in filtering. The default locale is the host environment's current locale."
},
{
name: "resizableColumns",
type: "boolean",
default: "false",
description: "When enabled, columns can be resized using drag and drop."
name: 'resizableColumns',
type: 'boolean',
default: 'false',
description: 'When enabled, columns can be resized using drag and drop.'
},
{
name: "columnResizeMode",
type: "string",
default: "fit",
name: 'columnResizeMode',
type: 'string',
default: 'fit',
description: 'Defines whether the overall table width should change on column resize, valid values are "fit" and "expand".'
},
{
name: "indentation",
type: "number",
default: "1",
description: "Indentation factor as rem value for children nodes. Defaults to 1rem."
name: 'indentation',
type: 'number',
default: '1',
description: 'Indentation factor as rem value for children nodes. Defaults to 1rem.'
},
{
name: "showGridlines",
type: "boolean",
default: "false",
description: "Whether to show grid lines between cells."
name: 'showGridlines',
type: 'boolean',
default: 'false',
description: 'Whether to show grid lines between cells.'
},
{
name: "scrollable",
type: "boolean",
default: "false",
description: "When specified, enables horizontal and/or vertical scrolling."
name: 'scrollable',
type: 'boolean',
default: 'false',
description: 'When specified, enables horizontal and/or vertical scrolling.'
},
{
name: "scrollDirection",
type: "string",
default: "vertical",
name: 'scrollDirection',
type: 'string',
default: 'vertical',
description: 'Orientation of the scrolling, options are "vertical", "horizontal" and "both".'
},
{
name: "scrollHeight",
type: "string",
default: "null",
name: 'scrollHeight',
type: 'string',
default: 'null',
description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.'
},
{
name: "responsiveLayout",
type: "string",
default: "null",
name: 'responsiveLayout',
type: 'string',
default: 'null',
description: 'Defines the responsive mode, currently only option is scroll.'
}
];
const TreeTableEvents = [
{
name: "page",
description: "Callback to invoke on pagination. Sort and Filter information is also available for lazy loading implementation.",
name: 'page',
description: 'Callback to invoke on pagination. Sort and Filter information is also available for lazy loading implementation.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.page",
type: "number",
description: "New page number"
name: 'event.page',
type: 'number',
description: 'New page number'
},
{
name: "event.pageCount",
type: "number",
description: "Total page count"
name: 'event.pageCount',
type: 'number',
description: 'Total page count'
},
{
name: "event.first",
type: "number",
description: "Index of first record"
name: 'event.first',
type: 'number',
description: 'Index of first record'
},
{
name: "event.rows",
type: "number",
description: "Number of rows to display in new page"
name: 'event.rows',
type: 'number',
description: 'Number of rows to display in new page'
},
{
name: "event.sortField",
type: "object",
description: "Field to sort against"
name: 'event.sortField',
type: 'object',
description: 'Field to sort against'
},
{
name: "event.sortOrder",
type: "number",
description: "Sort order as integer"
name: 'event.sortOrder',
type: 'number',
description: 'Sort order as integer'
},
{
name: "event.multiSortMeta",
type: "object",
description: "MultiSort metadata"
name: 'event.multiSortMeta',
type: 'object',
description: 'MultiSort metadata'
},
{
name: "event.filters",
type: "object",
description: "Collection of active filters"
name: 'event.filters',
type: 'object',
description: 'Collection of active filters'
},
{
name: "event.filterMatchModes",
type: "object",
description: "Match modes per field"
name: 'event.filterMatchModes',
type: 'object',
description: 'Match modes per field'
}
]
},
{
name: "sort",
description: "Callback to invoke on sort. Page and Filter information is also available for lazy loading implementation.",
name: 'sort',
description: 'Callback to invoke on sort. Page and Filter information is also available for lazy loading implementation.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.first",
type: "number",
description: "Index of first record"
name: 'event.first',
type: 'number',
description: 'Index of first record'
},
{
name: "event.rows",
type: "number",
description: "Number of rows to display in new page"
name: 'event.rows',
type: 'number',
description: 'Number of rows to display in new page'
},
{
name: "event.sortField",
type: "object",
description: "Field to sort against"
name: 'event.sortField',
type: 'object',
description: 'Field to sort against'
},
{
name: "event.sortOrder",
type: "number",
description: "Sort order as integer"
name: 'event.sortOrder',
type: 'number',
description: 'Sort order as integer'
},
{
name: "event.multiSortMeta",
type: "object",
description: "MultiSort metadata"
name: 'event.multiSortMeta',
type: 'object',
description: 'MultiSort metadata'
},
{
name: "event.filters",
type: "object",
description: "Collection of active filters"
name: 'event.filters',
type: 'object',
description: 'Collection of active filters'
},
{
name: "event.filterMatchModes",
type: "object",
description: "Match modes per field"
name: 'event.filterMatchModes',
type: 'object',
description: 'Match modes per field'
}
]
},
{
name: "filter",
description: "Event to emit after filtering, not triggered in lazy mode.",
name: 'filter',
description: 'Event to emit after filtering, not triggered in lazy mode.',
arguments: [
{
name: "event.originalEvent",
type: "object",
description: "Original event"
name: 'event.originalEvent',
type: 'object',
description: 'Original event'
},
{
name: "event.first",
type: "number",
description: "Index of first record"
name: 'event.first',
type: 'number',
description: 'Index of first record'
},
{
name: "event.rows",
type: "number",
description: "Number of rows to display in new page"
name: 'event.rows',
type: 'number',
description: 'Number of rows to display in new page'
},
{
name: "event.sortField",
type: "object",
description: "Field to sort against"
name: 'event.sortField',
type: 'object',
description: 'Field to sort against'
},
{
name: "event.sortOrder",
type: "number",
description: "Sort order as integer"
name: 'event.sortOrder',
type: 'number',
description: 'Sort order as integer'
},
{
name: "event.multiSortMeta",
type: "object",
description: "MultiSort metadata"
name: 'event.multiSortMeta',
type: 'object',
description: 'MultiSort metadata'
},
{
name: "event.filters",
type: "object",
description: "Collection of active filters"
name: 'event.filters',
type: 'object',
description: 'Collection of active filters'
},
{
name: "event.filteredValue",
type: "string",
description: "Filtered collection"
name: 'event.filteredValue',
type: 'string',
description: 'Filtered collection'
},
{
name: "event.filterMatchModes",
type: "object",
description: "Match modes per field"
name: 'event.filterMatchModes',
type: 'object',
description: 'Match modes per field'
}
]
},
{
name: "node-select",
description: "Callback to invoke when a node is selected.",
name: 'node-select',
description: 'Callback to invoke when a node is selected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-unselect",
description: "Callback to invoke when a node is unselected.",
name: 'node-unselect',
description: 'Callback to invoke when a node is unselected.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-expand",
description: "Callback to invoke when a node is expanded.",
name: 'node-expand',
description: 'Callback to invoke when a node is expanded.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "node-collapse",
description: "Callback to invoke when a node is collapsed.",
name: 'node-collapse',
description: 'Callback to invoke when a node is collapsed.',
arguments: [
{
name: "node",
type: "object",
description: "Node instance"
name: 'node',
type: 'object',
description: 'Node instance'
}
]
},
{
name: "column-resize-end",
description: "Callback to invoke when a column is resized.",
name: 'column-resize-end',
description: 'Callback to invoke when a column is resized.',
arguments: [
{
name: "event.element",
type: "object",
description: "DOM element of the resized column."
name: 'event.element',
type: 'object',
description: 'DOM element of the resized column.'
},
{
name: "event.delta",
type: "number",
description: "Change in column width"
name: 'event.delta',
type: 'number',
description: 'Change in column width'
}
]
}
@ -441,31 +442,31 @@ const TreeTableEvents = [
const TreeTableSlots = [
{
name: "header",
name: 'header',
description: "Custom content for the component's header"
},
{
name: "paginatorstart",
name: 'paginatorstart',
description: "Custom content for the component paginator's left side"
},
{
name: "paginatorend",
name: 'paginatorend',
description: "Custom content for the component paginator's right side"
},
{
name: "empty",
description: "Custom content when there is no data to display"
name: 'empty',
description: 'Custom content when there is no data to display'
},
{
name: "footer",
name: 'footer',
description: "Custom content for the component's footer"
}
];
module.exports = {
treetable: {
name: "TreeTable",
description: "TreeTable is used to display hierarchical data in tabular format.",
name: 'TreeTable',
description: 'TreeTable is used to display hierarchical data in tabular format.',
props: TreeTableProps,
events: TreeTableEvents,
slots: TreeTableSlots

Some files were not shown because too many files have changed in this diff Show More