Merge branch 'master' into feature/column-filter-apply-filter-prop
# Conflicts: # components/lib/datatable/ColumnFilter.vuepull/3520/head
BenjaminMINK
commit
b6c2073526
12
.eslintrc.js
12
.eslintrc.js
|
|
@ -7,10 +7,15 @@ module.exports = {
|
|||
extends: ['plugin:nuxt/recommended', 'plugin:vue/vue3-essential', 'prettier'],
|
||||
parserOptions: {
|
||||
parser: '@babel/eslint-parser',
|
||||
requireConfigFile: false
|
||||
requireConfigFile: false,
|
||||
babelOptions: {
|
||||
parserOpts: {
|
||||
plugins: ['typescript']
|
||||
}
|
||||
}
|
||||
},
|
||||
plugins: ['prettier'],
|
||||
ignorePatterns: ['**/public/**', '/layouts/AppDocumentation.vue'],
|
||||
ignorePatterns: ['**/public/**', '**/dist/**'],
|
||||
rules: {
|
||||
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
|
||||
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
|
||||
|
|
@ -87,7 +92,8 @@ module.exports = {
|
|||
{ blankLine: 'always', prev: 'block', next: '*' },
|
||||
{ blankLine: 'always', prev: '*', next: 'block' },
|
||||
{ blankLine: 'always', prev: 'block-like', next: '*' },
|
||||
{ blankLine: 'always', prev: '*', next: 'block-like' }
|
||||
{ blankLine: 'always', prev: '*', next: 'block-like' },
|
||||
{ blankLine: 'always', prev: ['import'], next: ['const', 'let', 'var'] }
|
||||
]
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@ body:
|
|||
id: reproducer
|
||||
attributes:
|
||||
label: Reproducer
|
||||
placeholder: https://codesandbox.io/s/primevue-3-issue-template-ip3vm
|
||||
placeholder: https://codesandbox.io/s/primevue-create-vue-issue-template-kw9g6i
|
||||
description: |
|
||||
Please fork one of the issue template
|
||||
[PrimeVue 3 Issue Template](https://codesandbox.io/s/primevue-3-issue-template-ip3vm)
|
||||
[PrimeVue TypeScript Issue Template](https://codesandbox.io/s/primevue-3-typescript-issue-template-z1f6e2)
|
||||
[PrimeVue 3 Issue Template](https://codesandbox.io/s/primevue-create-vue-issue-template-kw9g6i)
|
||||
[PrimeVue TypeScript Issue Template](https://codesandbox.io/s/primevue-create-vue-typescript-issue-template-fb775d)
|
||||
[PrimeVue 2 Issue Template](https://codesandbox.io/s/primevue-2-issue-template-dw7jd7)
|
||||
and create a case demonstrating your bug report. Issues **without** a CodeSandbox have much less possibility to be reviewed.
|
||||
validations:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
contact_links:
|
||||
- name: Support
|
||||
url: https://www.primefaces.org/primevue/support/
|
||||
url: https://primevue.org/support/
|
||||
about: Professional support for the open source innovation.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
name: Generate API DOC
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
paths:
|
||||
- '**/**/*.d.ts'
|
||||
- '/api-generator/build-apidoc.js'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
if: github.repository == 'primefaces/primevue' && github.ref == 'refs/heads/master'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install node packages
|
||||
run: npm install
|
||||
|
||||
- name: Generate api doc
|
||||
run: npm run apidoc
|
||||
|
||||
- name: Commit doc
|
||||
run: |
|
||||
git config user.name "GitHub Actions Bot"
|
||||
git config user.email "<>"
|
||||
git commit -a -m "Update API doc"
|
||||
git push
|
||||
|
|
@ -5,7 +5,7 @@ on:
|
|||
branches: [master]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
|
@ -16,10 +16,10 @@ jobs:
|
|||
node-version: [16.x, 18.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
|
|
@ -31,19 +31,29 @@ jobs:
|
|||
- name: Lint Check
|
||||
if: ${{ success() }}
|
||||
run: |
|
||||
npm run format:check
|
||||
npm run lint
|
||||
|
||||
- name: Code Format
|
||||
- name: Code Format Check
|
||||
id: codeFormatCheck
|
||||
if: ${{ success() }}
|
||||
run: |
|
||||
npm run format:check
|
||||
|
||||
- name: Code Format
|
||||
if: always() && steps.codeFormatCheck.outcome == 'failure'
|
||||
run: |
|
||||
npm run format
|
||||
git config user.name "GitHub Actions Bot"
|
||||
git config user.email "<>"
|
||||
git commit -a -m "Code Format"
|
||||
git push
|
||||
|
||||
- name: Security Check
|
||||
if: ${{ success() }}
|
||||
run: |
|
||||
npm run security:check
|
||||
|
||||
- name: Test
|
||||
if: ${{ success() }}
|
||||
run: |
|
||||
npm run test:unit
|
||||
# - name: Unit Tests Check
|
||||
# if: ${{ success() }}
|
||||
# run: |
|
||||
# npm run test:unit
|
||||
|
|
|
|||
|
|
@ -44,6 +44,14 @@ jobs:
|
|||
run: |
|
||||
npm run test:unit
|
||||
|
||||
- name: Lint
|
||||
run: |
|
||||
npm run lint
|
||||
|
||||
- name: Security
|
||||
run: |
|
||||
npm run security:check
|
||||
|
||||
- name: Add Code Format Fail Comment
|
||||
if: always() && steps.codeFormat.outcome == 'failure'
|
||||
uses: thollander/actions-comment-pull-request@v1
|
||||
|
|
|
|||
|
|
@ -9,11 +9,3 @@ coverage
|
|||
dist
|
||||
.DS_Store
|
||||
.vscode
|
||||
|
||||
# Themes
|
||||
public/themes/soho-light/
|
||||
public/themes/soho-dark/
|
||||
public/themes/viva-light/
|
||||
public/themes/viva-dark/
|
||||
public/themes/mira/
|
||||
public/themes/nano/
|
||||
3457
CHANGELOG.md
3457
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018-2022 PrimeTek
|
||||
Copyright (c) 2018-2023 PrimeTek
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
278
README.md
278
README.md
|
|
@ -3,157 +3,109 @@
|
|||
[](https://badge.fury.io/js/primevue)
|
||||
[](https://discord.gg/gzKFYnpmCY)
|
||||
|
||||
[](https://www.primefaces.org/primevue)
|
||||
[](https://primevue.org/)
|
||||
|
||||
# PrimeVue
|
||||
|
||||
PrimeVue is a rich set of open source UI Components for Vue. See [PrimeVue homepage](https://www.primefaces.org/primevue/) for live showcase and documentation.
|
||||
PrimeVue is a rich set of open source UI Components for Vue. See [PrimeVue homepage](https://primevue.org/) for live showcase and documentation.
|
||||
|
||||
## Download
|
||||
|
||||
PrimeVue is available at npm, if you have an existing application run the following command to download it to your project.
|
||||
PrimeVue is available at [npm](https://www.npmjs.com/package/primevue).
|
||||
|
||||
````
|
||||
npm install primevue@^3 --save
|
||||
npm install primeicons --save
|
||||
````
|
||||
// with npm
|
||||
npm install primevue
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
// with yarn
|
||||
yarn add primevue
|
||||
yarn add primeicons
|
||||
```
|
||||
````
|
||||
|
||||
Next step is setting up PrimeVue configuration.
|
||||
## Plugin
|
||||
|
||||
PrimeVue plugin is required to be installed with the **use** function to set up the default [configuration](https://primevue.org/theming).
|
||||
|
||||
```javascript
|
||||
import {createApp} from 'vue';
|
||||
import App from './App.vue';
|
||||
import PrimeVue from 'primevue/config';
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue);
|
||||
```
|
||||
|
||||
## Import
|
||||
## Theming
|
||||
PrimeVue has two theming has modes; styled or unstyled.
|
||||
|
||||
### Module
|
||||
**Styled Mode**
|
||||
|
||||
Styled mode is based on pre-skinned components with opinionated themes like Material, Bootstrap or PrimeOne themes. Theme is the required css file to be imported, visit the [Themes](https://primevue.org/theming) section for the complete list of available themes to choose from.
|
||||
|
||||
```javascript
|
||||
import {createApp} from 'vue';
|
||||
import App from './App.vue';
|
||||
import PrimeVue from 'primevue/config';
|
||||
import Dialog from 'primevue/dialog';
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue);
|
||||
|
||||
app.component('Dialog', Dialog);
|
||||
// theme
|
||||
import 'primevue/resources/themes/lara-light-blue/theme.css';
|
||||
```
|
||||
|
||||
Finally you'll be able to utilize the component in your application. See the Styles section to apply styling.
|
||||
Each PrimeVue theme has its own font family so it is suggested to apply it to your application for a unified look.
|
||||
|
||||
```
|
||||
body {
|
||||
font-family: var(--font-family);
|
||||
}
|
||||
```
|
||||
|
||||
**Unstyled Mode**
|
||||
|
||||
Unstyled mode is disabled by default for all components. Using the PrimeVue plugin during installation, set `unstyled` as true to enable it globally. Visit the [Unstyled mode](https://primevue.org/unstyled) documentation for more information and examples.
|
||||
|
||||
```javascript
|
||||
import { createApp } from "vue";
|
||||
import PrimeVue from "primevue/config";
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue, { unstyled: true });
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Each component can be imported individually so that you only bundle what you use. Import path is available in the documentation of the corresponding component.
|
||||
|
||||
```javascript
|
||||
import Button from "primevue/button"
|
||||
|
||||
const app = createApp(App);
|
||||
app.component('Button', Button);
|
||||
```
|
||||
|
||||
|
||||
## Prop Cases
|
||||
|
||||
Component prop names are described as camel case throughout the documentation however kebap-case is also fully supported. Events on the other hand should always be kebap-case.
|
||||
|
||||
```vue
|
||||
<Dialog></Dialog>
|
||||
<Dialog :showHeader="false"></Dialog>
|
||||
|
||||
<!-- can be written as -->
|
||||
|
||||
<Dialog :show-header="false"></Dialog>
|
||||
```
|
||||
|
||||
### CDN
|
||||
|
||||
```javascript
|
||||
<script src="https://unpkg.com/primevue@^3/core/core.min.js"></script>/script>
|
||||
<script src="https://unpkg.com/primevue@^3/multiselect/multiselect.min.js"></script>
|
||||
```
|
||||
|
||||
## Single File Components
|
||||
|
||||
SFC files are available in the npm distribution and if you'd like to use SFCs directly, add ***/sfc*** as a suffix when referencing an import path. This will instruct your bundler to process the *.vue files in your local build instead of using the compiled output. One use case for this approach is optimizing for SSR by removing whitespaces.
|
||||
|
||||
```javascript
|
||||
import Dialog from 'primevue/dialog/sfc';
|
||||
```
|
||||
|
||||
## Script Tag
|
||||
|
||||
Other alternative is utilizing the components directly within the browser with the ***iife*** build. Note that PrimeVue does not provide a ***umd*** build.
|
||||
|
||||
```javascript
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>PrimeVue Demo</title>
|
||||
<link href="https://unpkg.com/primevue/resources/themes/lara-light-indigo/theme.css" rel="stylesheet">
|
||||
<link href="https://unpkg.com/primevue/resources/primevue.min.css" rel="stylesheet">
|
||||
<link href="https://unpkg.com/primeicons/primeicons.css" rel="stylesheet">
|
||||
|
||||
<script src="https://unpkg.com/vue@next"></script>
|
||||
<script src="https://unpkg.com/primevue^3/core/core.min.js"></script>
|
||||
<script src="https://unpkg.com/primevue^3/slider/slider.min.js"></script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="app">
|
||||
<p-slider v-model="val"></p-slider>
|
||||
<h6>{{val}}</h6>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
const {createApp, ref} = Vue;
|
||||
|
||||
const App = {
|
||||
setup() {
|
||||
const val = ref(null);
|
||||
|
||||
return {
|
||||
val
|
||||
};
|
||||
},
|
||||
components: {
|
||||
'p-slider': primevue.slider
|
||||
}
|
||||
};
|
||||
|
||||
createApp(App).use(primevue.config.default).mount("#app");
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## Styles
|
||||
|
||||
The css dependencies are as follows, note that you may change the theme with another one of your choice.
|
||||
|
||||
```css
|
||||
primevue/resources/themes/saga-blue/theme.css //theme
|
||||
primevue/resources/primevue.min.css //core css
|
||||
primeicons/primeicons.css //icons
|
||||
```
|
||||
|
||||
If you are using a bundler such as webpack with a css loader you may also import them to your main application component.
|
||||
|
||||
```javascript
|
||||
import 'primevue/resources/themes/lara-light-indigo/theme.css';
|
||||
import 'primevue/resources/primevue.min.css';
|
||||
import 'primeicons/primeicons.css';
|
||||
```
|
||||
|
||||
## Nuxt Integration
|
||||
|
||||
Nuxt 3 is currently in beta and an official module is planned after the final release. At the moment, PrimeVue can easily be used with Nuxt 3 using a custom plugin.
|
||||
PrimeVue can easily be used with Nuxt 3 using a custom plugin.
|
||||
|
||||
**nuxt.config.js**
|
||||
|
||||
Open the nuxt configuration file and add the css dependencies.
|
||||
|
||||
```javascript
|
||||
import { defineNuxtConfig } from 'nuxt3';
|
||||
|
||||
export default defineNuxtConfig({
|
||||
css: [
|
||||
'primevue/resources/themes/saga-blue/theme.css',
|
||||
'primevue/resources/primevue.css',
|
||||
'primeicons/primeicons.css'
|
||||
]
|
||||
"primevue/resources/themes/lara-light-blue/theme.css"
|
||||
],
|
||||
build: {
|
||||
transpile: ["primevue"]
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
|
|
@ -173,92 +125,32 @@ export default defineNuxtPlugin((nuxtApp) => {
|
|||
});
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Example
|
||||
|
||||
### Dependencies
|
||||
We've created various samples for the popular options in the Vue ecosystem. Visit the [primevue-examples](https://github.com/primefaces/primevue-examples) repository for the samples.
|
||||
|
||||
PrimeVue components are not wrappers and implemented natively with the Vue APIs. There are some exceptions having 3rd party dependencies such as Quill for Editor.
|
||||
### Vite
|
||||
<a href="https://github.com/primefaces/primevue-examples/tree/main/vite-quickstart">
|
||||
<img src="https://primefaces.org/cdn/primevue/images/logos/vite.svg" alt="vite" width="112" height="112">
|
||||
</a>
|
||||
|
||||
In addition, components require PrimeIcons library for icons.
|
||||
### Nuxt
|
||||
<a href="https://github.com/primefaces/primevue-examples/tree/main/nuxt3-quickstart">
|
||||
<img src="https://primefaces.org/cdn/primevue/images/logos/nuxt.svg" alt="nuxt" width="112" height="112">
|
||||
</a>
|
||||
|
||||
```javascript
|
||||
dependencies: {
|
||||
"vue": "^3.0.0",
|
||||
"primeicons": "^5.0.0"
|
||||
}
|
||||
```
|
||||
### Vue-CLI
|
||||
<a href="https://github.com/primefaces/primevue-quickstart">
|
||||
<img src="https://primefaces.org/cdn/primevue/images/logos/vue.svg" alt="vue-cli" width="112" height="112">
|
||||
</a>
|
||||
|
||||
## Prop Cases
|
||||
### Astro
|
||||
<a href="https://github.com/primefaces/primevue-examples/tree/main/astro-quickstart">
|
||||
<img src="https://primefaces.org/cdn/primevue/images/logos/astro.svg" alt="astro" width="112" height="112">
|
||||
</a>
|
||||
|
||||
Component prop names are described as camel case throughout the documentation however camel-case is also fully supported. Events on the other hand should always be camel-case.
|
||||
## Contributors
|
||||
|
||||
```vue
|
||||
<Dialog :showHeader="false"></Dialog>
|
||||
|
||||
<!-- can be written as -->
|
||||
|
||||
<Dialog :show-header="false"></Dialog>
|
||||
```
|
||||
|
||||
## Ripple
|
||||
|
||||
Ripple is an optional animation for the supported components such as buttons. It is disabled by default and needs to be enabled at your app's entry file (e.g. main.js) during the PrimeVue setup.
|
||||
|
||||
```javascript
|
||||
import {createApp} from 'vue';
|
||||
import PrimeVue from 'primevue/config';
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue, {ripple: true});
|
||||
```
|
||||
|
||||
## Outlined vs Filled Input Styles
|
||||
|
||||
Input fields come in two styles, default is ***outlined*** with borders around the field whereas ***filled*** alternative adds a background color to the field. Applying *p-input-filled* to an ancestor of an input enables the filled style. If you prefer to use filled inputs in the entire application, use a global container such as the document body or the application element to apply the style class. Note that in case you add it to the application element, components that are teleported to the document body such as Dialog will not be able to display filled inputs as they are not a descendant of the application root element in the DOM tree, to resolve this case set inputStyle to 'filled' at PrimeVue configuration as well.
|
||||
|
||||
```javascript
|
||||
import {createApp} from 'vue';
|
||||
import PrimeVue from 'primevue/config';
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue, {inputStyle: 'filled'});
|
||||
```
|
||||
|
||||
## ZIndex Layering
|
||||
|
||||
ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. Still there may be cases where you'd like to configure the configure default values such as a custom layout where header section is fixed. In a case like this, dropdown needs to be displayed below the application header but a modal dialog should be displayed above. PrimeVue configuration offers the ***zIndex*** property to customize the default values for components categories. Default values are described below and can be customized when setting up PrimeVue.
|
||||
|
||||
```javascript
|
||||
import {createApp} from 'vue';
|
||||
import PrimeVue from 'primevue/config';
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(PrimeVue, {
|
||||
zIndex: {
|
||||
modal: 1100, //dialog, sidebar
|
||||
overlay: 1000, //dropdown, overlaypanel
|
||||
menu: 1000, //overlay menus
|
||||
tooltip: 1100 //tooltip
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## Locale
|
||||
|
||||
PrimeVue provides a Locale API to support i18n and l7n, visit the [Locale](https://www.primefaces.org/primevue/showcase/#/locale) documentation for more information.
|
||||
|
||||
## Quickstart with Vue CLI
|
||||
|
||||
An [example application](https://github.com/primefaces/primevue-quickstart) based on Vue CLI is available at github.
|
||||
|
||||
## Quickstart with Vite
|
||||
|
||||
A [starter application](https://github.com/primefaces/primevue-quickstart-vite) is also provided for Vite users.
|
||||
|
||||
## Quickstart with Nuxt
|
||||
|
||||
A [sample application](https://github.com/primefaces/primevue-quickstart-nuxt3) is created for Nuxt 3 users.
|
||||
|
||||
## Quickstart with TypeScript
|
||||
|
||||
Typescript is fully supported as type definition files are provided in the npm package of PrimeVue. A sample [typescript-primevue](https://github.com/primefaces/primevue-typescript-quickstart) application with Vue CLI is available as at github.
|
||||
<a href="https://github.com/primefaces/primevue/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=primefaces/primevue" />
|
||||
</a>
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ 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://primevue.org/';
|
||||
|
||||
const fileModules = {},
|
||||
veturTags = {},
|
||||
|
|
@ -156,6 +156,8 @@ Object.keys(fileModules).forEach((p) => {
|
|||
createVeturAttributes(fileModules[p][p]);
|
||||
});
|
||||
|
||||
!fs.existsSync(distDir) && fs.mkdirSync(distDir);
|
||||
|
||||
const webTypesJson = JSON.stringify(webTypes, null, 2);
|
||||
|
||||
fs.writeFileSync(path.resolve(distDir, 'web-types.json'), webTypesJson);
|
||||
|
|
|
|||
|
|
@ -0,0 +1,506 @@
|
|||
const TypeDoc = require('typedoc');
|
||||
const path = require('path');
|
||||
const fs = require('fs');
|
||||
|
||||
const rootDir = path.resolve(__dirname, '../');
|
||||
const outputPath = path.resolve(rootDir, 'doc/common/apidoc');
|
||||
|
||||
const staticMessages = {
|
||||
methods: "Defines methods that can be accessed by the component's reference.",
|
||||
emits: 'Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.',
|
||||
slots: 'Defines the slots used by the component.',
|
||||
functions: 'Defines the custom functions used by the module.',
|
||||
events: "Defines the custom events used by the component's emit.",
|
||||
interfaces: 'Defines the custom interfaces used by the module.',
|
||||
types: 'Defines the custom types used by the module.'
|
||||
};
|
||||
|
||||
const app = new TypeDoc.Application();
|
||||
|
||||
// If you want TypeDoc to load tsconfig.json / typedoc.json files
|
||||
app.options.addReader(new TypeDoc.TSConfigReader());
|
||||
app.options.addReader(new TypeDoc.TypeDocReader());
|
||||
|
||||
app.bootstrap({
|
||||
// typedoc options here
|
||||
name: 'PrimeVue',
|
||||
entryPoints: [`components/lib/`],
|
||||
entryPointStrategy: 'expand',
|
||||
hideGenerator: true,
|
||||
excludeExternals: true,
|
||||
includeVersion: true,
|
||||
searchInComments: true,
|
||||
disableSources: true,
|
||||
logLevel: 'Error',
|
||||
sort: ['source-order'],
|
||||
exclude: ['node_modules', 'components/lib/**/*.js']
|
||||
});
|
||||
|
||||
const project = app.convert();
|
||||
|
||||
if (project) {
|
||||
const doc = {};
|
||||
|
||||
const parseText = (text) => {
|
||||
return text.replace(/{/g, '{').replace(/}/g, '}');
|
||||
};
|
||||
|
||||
project.children.forEach((module) => {
|
||||
const { name, comment } = module;
|
||||
|
||||
const description = comment && comment.summary.map((s) => s.text || '').join(' ');
|
||||
|
||||
doc[name] = {
|
||||
description
|
||||
};
|
||||
|
||||
const module_component_group = module.groups.find((g) => g.title === 'Component');
|
||||
let methods = {
|
||||
description: staticMessages['methods'],
|
||||
values: []
|
||||
};
|
||||
|
||||
module_component_group &&
|
||||
module_component_group.children.forEach((component) => {
|
||||
const description =
|
||||
component.comment &&
|
||||
component.comment.summary
|
||||
.map((s) => {
|
||||
const text = s.text || '';
|
||||
const splittedText = text.split('_');
|
||||
|
||||
return splittedText[1] ? splittedText[1] : text;
|
||||
})
|
||||
.join(' ');
|
||||
|
||||
!doc[name]['components'] && (doc[name]['components'] = {});
|
||||
|
||||
const component_method_group = component.groups && component.groups.find((g) => g.title === 'Methods');
|
||||
|
||||
component_method_group &&
|
||||
component_method_group.children.forEach((method) => {
|
||||
const signature = method.getAllSignatures()[0];
|
||||
|
||||
methods.values.push({
|
||||
name: signature.name,
|
||||
parameters: signature.parameters.map((param) => {
|
||||
return {
|
||||
name: param.name,
|
||||
type: param.type.toString(),
|
||||
description: param.comment && param.comment.summary.map((s) => s.text || '').join(' ')
|
||||
};
|
||||
}),
|
||||
returnType: signature.type.toString(),
|
||||
description: signature.comment && signature.comment.summary.map((s) => s.text || '').join(' ')
|
||||
});
|
||||
});
|
||||
|
||||
const component_props_id = component.extendedTypes && component.extendedTypes[0].typeArguments && component.extendedTypes[0].typeArguments[0] && component.extendedTypes[0].typeArguments[0]._target;
|
||||
const module_properties_group = module.groups.find((g) => g.title === 'Properties');
|
||||
const component_props = module_properties_group && module_properties_group.children.find((c) => (component_props_id ? c.id === component_props_id : true));
|
||||
|
||||
const props = {
|
||||
description: '',
|
||||
values: []
|
||||
};
|
||||
const emit = {
|
||||
description: staticMessages['emit'],
|
||||
values: []
|
||||
};
|
||||
|
||||
if (component_props) {
|
||||
props.description = component_props.comment ? component_props.comment.summary.map((s) => parseText(s.text || '')).join(' ') : '';
|
||||
|
||||
const component_props_group = component_props.groups && component_props.groups.find((g) => g.title === 'Properties');
|
||||
|
||||
component_props_group &&
|
||||
component_props_group.children.forEach((prop) => {
|
||||
if (!prop.inheritedFrom || (prop.inheritedFrom && !prop.inheritedFrom.toString().startsWith('Omit.data-pr-'))) {
|
||||
props.values.push({
|
||||
name: prop.name,
|
||||
optional: prop.flags.isOptional,
|
||||
readonly: prop.flags.isReadonly,
|
||||
type: prop.type.toString(),
|
||||
default: prop.comment && prop.comment.getTag('@defaultValue') ? parseText(prop.comment.getTag('@defaultValue').content[0].text) : '', // TODO: Check
|
||||
description: prop.comment && prop.comment.summary.map((s) => parseText(s.text || '')).join(' '),
|
||||
deprecated: prop.comment && prop.comment.getTag('@deprecated') ? parseText(prop.comment.getTag('@deprecated').content[0].text) : undefined
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
const component_props_methods_group = component_props.groups && component_props.groups.find((g) => g.title === 'Methods');
|
||||
|
||||
component_props_methods_group &&
|
||||
component_props_methods_group.children.forEach((method) => {
|
||||
const signature = method.getAllSignatures()[0];
|
||||
|
||||
methods.values.push({
|
||||
name: signature.name,
|
||||
parameters: signature.parameters.map((param) => {
|
||||
return {
|
||||
name: param.name,
|
||||
optional: param.flags.isOptional,
|
||||
type: param.type.toString(),
|
||||
description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
||||
};
|
||||
}),
|
||||
returnType: signature.type.toString(),
|
||||
description: signature.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
doc[name]['components'][component.name] = {
|
||||
description,
|
||||
methods
|
||||
};
|
||||
});
|
||||
|
||||
const module_model_group = module.groups.find((g) => g.title === 'Model');
|
||||
|
||||
module_model_group &&
|
||||
module_model_group.children.forEach((model) => {
|
||||
const event_props_description = model.comment && model.comment.summary.map((s) => s.text || '').join(' ');
|
||||
|
||||
!doc[name]['model'] && (doc[name]['model'] = {});
|
||||
|
||||
const props = {
|
||||
description: '',
|
||||
values: []
|
||||
};
|
||||
|
||||
const methods = {
|
||||
description: '',
|
||||
values: []
|
||||
};
|
||||
const model_props_group = model.groups.find((g) => g.title === 'Properties');
|
||||
|
||||
model_props_group &&
|
||||
model_props_group.children.forEach((prop) => {
|
||||
props.values.push({
|
||||
name: prop.name,
|
||||
optional: prop.flags.isOptional,
|
||||
readonly: prop.flags.isReadonly,
|
||||
type: prop.type.toString(),
|
||||
default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check
|
||||
description: prop.comment && prop.comment.summary.map((s) => s.text || '').join(' ')
|
||||
});
|
||||
});
|
||||
|
||||
const model_methods_group = model.groups.find((g) => g.title === 'Methods');
|
||||
|
||||
model_methods_group &&
|
||||
model_methods_group.children.forEach((method) => {
|
||||
const signature = method.getAllSignatures()[0];
|
||||
const isSlot = model.name.includes('Slots');
|
||||
|
||||
methods.values.push({
|
||||
name: signature.name,
|
||||
parameters: signature.parameters.map((param) => {
|
||||
let type = param.type.toString();
|
||||
|
||||
if (param.type.declaration && isSlot) {
|
||||
type = '';
|
||||
|
||||
if (param.type.declaration.children) {
|
||||
param.type.declaration.children.forEach((child) => {
|
||||
if (child.signatures) {
|
||||
const childSinature = child.signatures[0];
|
||||
const parameters = childSinature.parameters.reduce((acc, { name, type }, index) => (index === 0 ? `${name}: ${type.name}` : `${acc}, ${name}: ${type.name}`), '');
|
||||
|
||||
type += ` \t ${childSinature.name}(${parameters}): ${childSinature.type?.name}, // ${childSinature.comment?.summary[0]?.text}\n `;
|
||||
} else {
|
||||
const childType = child.type.elementType ? child.type.elementType.name : child.type.name;
|
||||
|
||||
type += ` \t ${child.name}: ${childType}, // ${child.comment?.summary[0]?.text}\n `;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
type = `{\n ${type} }`;
|
||||
}
|
||||
|
||||
return {
|
||||
name: param.name,
|
||||
optional: param.flags.isOptional,
|
||||
type: type,
|
||||
description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
||||
};
|
||||
}),
|
||||
returnType: signature.type.toString(),
|
||||
description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' '),
|
||||
deprecated: signature.comment && signature.comment.getTag('@deprecated') ? parseText(signature.comment.getTag('@deprecated').content[0].text) : undefined
|
||||
});
|
||||
});
|
||||
|
||||
doc[name]['model'][model.name] = {
|
||||
description: event_props_description,
|
||||
props,
|
||||
methods
|
||||
};
|
||||
});
|
||||
|
||||
const module_functions_group = module.groups.find((g) => g.title === 'Functions');
|
||||
|
||||
module_functions_group &&
|
||||
module_functions_group.children.forEach((method) => {
|
||||
!doc[name]['functions'] &&
|
||||
(doc[name]['functions'] = {
|
||||
description: staticMessages['functions'],
|
||||
values: {}
|
||||
});
|
||||
|
||||
const signatures = method.getAllSignatures();
|
||||
|
||||
if (signatures && signatures.length > 0) {
|
||||
const signature = signatures[0];
|
||||
|
||||
doc[name]['functions'].values[method.name] = {
|
||||
name: signature.name,
|
||||
parameters: signature.parameters.map((param) => {
|
||||
return {
|
||||
name: param.name,
|
||||
type: param.type.toString(),
|
||||
description: param.comment && param.comment.summary.map((s) => s.text || '').join(' ')
|
||||
};
|
||||
}),
|
||||
returnType: signature.type.toString(),
|
||||
description: signature.comment && signature.comment.summary.map((s) => s.text || '').join(' ')
|
||||
};
|
||||
}
|
||||
});
|
||||
|
||||
const module_events_group = module.groups.find((g) => g.title === 'Events');
|
||||
|
||||
module_events_group &&
|
||||
module_events_group.children.forEach((event) => {
|
||||
const event_props_description = event.comment && event.comment.summary.map((s) => s.text || '').join(' ');
|
||||
const component_prop = event.comment && event.comment.getTag('@see') ? event.comment.getTag('@see').content[0].text : ''; // TODO: Check
|
||||
const event_extendedBy = event.extendedBy && event.extendedBy.toString();
|
||||
|
||||
!doc[name]['events'] &&
|
||||
(doc[name]['events'] = {
|
||||
description: staticMessages['events'],
|
||||
values: {}
|
||||
});
|
||||
|
||||
const props = [];
|
||||
const event_props_group = event.groups.find((g) => g.title === 'Properties');
|
||||
|
||||
event_props_group &&
|
||||
event_props_group.children.forEach((prop) => {
|
||||
props.push({
|
||||
name: prop.name,
|
||||
optional: prop.flags.isOptional,
|
||||
readonly: prop.flags.isReadonly,
|
||||
type: prop.type.toString(),
|
||||
//default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check
|
||||
description: prop.comment && prop.comment.summary.map((s) => s.text || '').join(' ')
|
||||
});
|
||||
});
|
||||
|
||||
doc[name]['events'].values[event.name] = {
|
||||
description: event_props_description,
|
||||
relatedProp: component_prop,
|
||||
props,
|
||||
extendedBy: event_extendedBy
|
||||
};
|
||||
});
|
||||
|
||||
const module_interfaces_group = module.groups.find((g) => g.title === 'Interfaces');
|
||||
|
||||
module_interfaces_group &&
|
||||
module_interfaces_group.children.forEach((event) => {
|
||||
const event_props_description = event.comment && event.comment.summary.map((s) => s.text || '').join(' ');
|
||||
let component_prop = '';
|
||||
|
||||
if (event.comment && event.comment.getTag('@see')) {
|
||||
const tag = event.comment.getTag('@see');
|
||||
const content = tag.content[0];
|
||||
|
||||
if (content.text.includes("['")) {
|
||||
component_prop = `${content.target.name}${content.text}`;
|
||||
} else {
|
||||
component_prop = `${content.text === content.target?.name ? content.target.parent.name : content.target?.name}.${content.text}`;
|
||||
}
|
||||
}
|
||||
|
||||
const event_extendedBy = event.extendedBy && event.extendedBy.toString();
|
||||
const event_extendedTypes = event.extendedTypes && event.extendedTypes.toString();
|
||||
|
||||
!doc[name]['interfaces'] &&
|
||||
(doc[name]['interfaces'] = {
|
||||
description: staticMessages['interfaces'],
|
||||
eventDescription: staticMessages['events'],
|
||||
methodDescription: staticMessages['methods'],
|
||||
typeDescription: staticMessages['types'],
|
||||
|
||||
values: {}
|
||||
});
|
||||
|
||||
const props = [];
|
||||
const methods = [];
|
||||
|
||||
if (event.groups) {
|
||||
const event_props_group = event.groups.find((g) => g.title === 'Properties');
|
||||
|
||||
event_props_group &&
|
||||
event_props_group.children.forEach((prop) => {
|
||||
props.push({
|
||||
name: prop.name,
|
||||
optional: prop.flags.isOptional,
|
||||
readonly: prop.flags.isReadonly,
|
||||
type: prop.type.toString(),
|
||||
default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check
|
||||
description: prop.comment && prop.comment.summary.map((s) => s.text || '').join(' '),
|
||||
deprecated: prop.comment && prop.comment.getTag('@deprecated') ? parseText(prop.comment.getTag('@deprecated').content[0].text) : undefined
|
||||
});
|
||||
});
|
||||
|
||||
const event_methods_group = event.groups.find((g) => g.title === 'Methods');
|
||||
|
||||
event_methods_group &&
|
||||
event_methods_group.children.forEach((method) => {
|
||||
const signature = method.getAllSignatures()[0];
|
||||
const isSlot = event.name.includes('Slots');
|
||||
|
||||
methods.push({
|
||||
name: signature.name,
|
||||
parameters: signature.parameters.map((param) => {
|
||||
let type = param.type.toString();
|
||||
|
||||
if (param.type.declaration && isSlot) {
|
||||
type = '';
|
||||
|
||||
if (param.type.declaration.children) {
|
||||
param.type.declaration.children.forEach((child) => {
|
||||
if (child.signatures) {
|
||||
const childSinature = child.signatures[0];
|
||||
const parameters = childSinature.parameters.reduce((acc, { name, type }, index) => (index === 0 ? `${name}: ${type.name}` : `${acc}, ${name}: ${type.name}`), '');
|
||||
|
||||
type += ` \t <b>${childSinature.name}(${parameters})</b>: ${childSinature.type?.name}, // ${childSinature.comment?.summary[0]?.text}\n `;
|
||||
} else {
|
||||
if (child.type?.declaration?.signatures) {
|
||||
let functionParameters = '';
|
||||
|
||||
child.type?.declaration?.signatures[0]?.parameters.map((param, index) => {
|
||||
if (index !== 0) functionParameters += `, `;
|
||||
functionParameters += `${param.name}: ${param.type?.name}`;
|
||||
});
|
||||
|
||||
type += `\t <b>${child.name}</b>: (${functionParameters}) ⇒ ${child.type?.declaration?.signatures[0]?.type?.name}, // ${child.type?.declaration?.signatures[0]?.comment.summary[0]?.text}\n`;
|
||||
} else {
|
||||
const childType = child.type.elementType ? child.type.elementType.name : child.type.name;
|
||||
|
||||
type += ` \t <b>${child.name}</b>: ${childType}, // ${child.comment?.summary[0]?.text}\n `;
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
type = `{\n ${type} }`;
|
||||
}
|
||||
|
||||
return {
|
||||
name: param.name,
|
||||
optional: param.flags.isOptional,
|
||||
type: type,
|
||||
description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
||||
};
|
||||
}),
|
||||
returnType: signature.type.toString(),
|
||||
description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' '),
|
||||
deprecated: signature.comment && signature.comment.getTag('@deprecated') ? parseText(signature.comment.getTag('@deprecated').content[0].text) : undefined
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
const signature = event.getAllSignatures();
|
||||
|
||||
if (signature && signature.length > 0) {
|
||||
const parameter = signature[0].parameters[0];
|
||||
|
||||
props.push({
|
||||
name: `[${parameter.name}: ${parameter.type.toString()}]`,
|
||||
optional: parameter.flags.isOptional,
|
||||
readonly: parameter.flags.isReadonly,
|
||||
type: signature[0].type.toString(),
|
||||
//default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check
|
||||
description: signature[0].comment && signature[0].comment.summary.map((s) => s.text || '').join(' ')
|
||||
});
|
||||
}
|
||||
|
||||
doc[name]['interfaces'].values[event.name] = {
|
||||
description: event_props_description,
|
||||
relatedProp: component_prop,
|
||||
props,
|
||||
methods,
|
||||
extendedBy: event_extendedBy,
|
||||
extendedTypes: event_extendedTypes
|
||||
};
|
||||
});
|
||||
|
||||
const module_types_group = module.groups.find((g) => g.title === 'Type Aliases');
|
||||
|
||||
module_types_group &&
|
||||
module_types_group.children.forEach((event) => {
|
||||
const event_props_description = event.comment && event.comment.summary.map((s) => s.text || '').join(' ');
|
||||
|
||||
!doc[name]['types'] &&
|
||||
(doc[name]['types'] = {
|
||||
description: staticMessages['types'],
|
||||
values: {}
|
||||
});
|
||||
|
||||
let values = event.type.toString();
|
||||
|
||||
if (values.includes('Function') && event.type.types) {
|
||||
values = '';
|
||||
|
||||
for (const [i, type] of event.type.types.entries()) {
|
||||
if (type.declaration && type.declaration.signatures) {
|
||||
const signature = type.declaration.signatures[0];
|
||||
const parameters = signature.parameters.reduce((acc, { name, type }, index) => (index === 0 ? `${name}: ${type.name}` : `${acc}, ${name}: ${type.name}`), '');
|
||||
|
||||
values += i === 0 ? `(${parameters}) => ${signature.type?.name}` : ` | (${parameters}) => ${signature.type?.name}`;
|
||||
} else {
|
||||
const typeName = type.name || type.value;
|
||||
|
||||
values += i === 0 ? `${typeName}` : ` | ${typeName}`;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const declaration = event.type.declaration;
|
||||
|
||||
if (declaration) {
|
||||
const groups = declaration.groups && declaration.groups.find((g) => g.title === 'Properties');
|
||||
|
||||
const map = {};
|
||||
|
||||
groups &&
|
||||
groups.children.forEach((prop) => {
|
||||
const description = prop.comment && prop.comment.summary.map((s) => s.text || '').join(' ');
|
||||
|
||||
map[`${prop.name}${prop.flags.isOptional ? '?' : ''}`] = `${prop.type.toString()}, ${description ? '// ' + description : ''}`;
|
||||
});
|
||||
|
||||
values = JSON.stringify(map, null, 4);
|
||||
}
|
||||
|
||||
doc[name]['types'].values[event.name] = {
|
||||
values,
|
||||
description: event_props_description
|
||||
};
|
||||
});
|
||||
|
||||
// app.generateJson(module, `./api-generator/module-typedoc.json`);
|
||||
});
|
||||
|
||||
const typedocJSON = JSON.stringify(doc, null, 4);
|
||||
|
||||
!fs.existsSync(outputPath) && fs.mkdirSync(outputPath);
|
||||
fs.writeFileSync(path.resolve(outputPath, 'index.json'), typedocJSON);
|
||||
|
||||
/* app.generateJson(project, `./api-generator/typedoc.json`); */
|
||||
}
|
||||
|
|
@ -20,13 +20,13 @@ const AccordionProps = [
|
|||
{
|
||||
name: 'expandIcon',
|
||||
type: 'string',
|
||||
default: 'pi-chevron-right',
|
||||
default: 'null',
|
||||
description: 'Icon of a collapsed tab.'
|
||||
},
|
||||
{
|
||||
name: 'collapseIcon',
|
||||
type: 'string',
|
||||
default: 'pi-chevron-down',
|
||||
default: 'null',
|
||||
description: 'Icon of a expanded tab.'
|
||||
},
|
||||
{
|
||||
|
|
@ -40,6 +40,18 @@ const AccordionProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, the focused tab is activated.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -21,13 +21,13 @@ const AccordionTabProps = [
|
|||
name: 'headerProps',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the tab header.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.'
|
||||
},
|
||||
{
|
||||
name: 'contentStyle',
|
||||
|
|
@ -45,13 +45,30 @@ const AccordionTabProps = [
|
|||
name: 'contentProps',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the tab content.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the tab content.'
|
||||
},
|
||||
{
|
||||
name: 'disabled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Whether the tab is disabled.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
const AccordionTabSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: 'Custom content for the title section of a AccordionTab is defined using the header template.'
|
||||
},
|
||||
{
|
||||
name: 'headericon',
|
||||
description: 'Custom icon for the header section of a AccordionTab is defined using the headericon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -59,6 +76,7 @@ module.exports = {
|
|||
accordiontab: {
|
||||
name: 'AccordionTab',
|
||||
description: 'Accordion element consists of one or more AccordionTab elements.',
|
||||
props: AccordionTabProps
|
||||
props: AccordionTabProps,
|
||||
slots: AccordionTabSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -77,6 +77,12 @@ const AutoCompleteProps = [
|
|||
default: 'null',
|
||||
description: 'Default text to display when no option is selected.'
|
||||
},
|
||||
{
|
||||
name: 'loading',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Whether the multiselect is in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'disabled',
|
||||
type: 'boolean',
|
||||
|
|
@ -133,7 +139,7 @@ const AutoCompleteProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -141,7 +147,7 @@ const AutoCompleteProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
|
|
@ -151,7 +157,7 @@ const AutoCompleteProps = [
|
|||
},
|
||||
{
|
||||
name: 'panelClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the overlay panel.'
|
||||
},
|
||||
|
|
@ -159,14 +165,32 @@ const AutoCompleteProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the dropdown.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownClass',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Style class of the dropdown button.'
|
||||
},
|
||||
{
|
||||
name: 'loadingIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-spinner',
|
||||
default: 'null',
|
||||
description: 'Icon to display in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'removeTokenIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in chip remove action.'
|
||||
},
|
||||
{
|
||||
name: 'virtualScrollerOptions',
|
||||
type: 'object',
|
||||
|
|
@ -232,6 +256,18 @@ const AutoCompleteProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying input element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -396,6 +432,18 @@ const AutoCompleteSlots = [
|
|||
{
|
||||
name: 'empty',
|
||||
description: 'Custom empty template when there is no data to display.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownicon',
|
||||
description: 'Custom dropdown icon template.'
|
||||
},
|
||||
{
|
||||
name: 'removetokenicon',
|
||||
description: 'Custom remove token icon template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -28,13 +28,39 @@ const AvatarProps = [
|
|||
type: 'string',
|
||||
default: 'square',
|
||||
description: 'Shape of the element, valid options are "square" and "circle".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const AvatarSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
const AvatarEvents = [
|
||||
{
|
||||
name: 'error',
|
||||
description: 'Triggered when an error occurs while loading an image file.'
|
||||
description: 'Triggered when an error occurs while loading an image file.',
|
||||
arguments: [
|
||||
{
|
||||
name: 'event',
|
||||
type: 'object',
|
||||
description: 'Browser event'
|
||||
}
|
||||
]
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -43,6 +69,7 @@ module.exports = {
|
|||
name: 'Avatar',
|
||||
description: 'Avatar represents people using icons, labels and images.',
|
||||
props: AvatarProps,
|
||||
slots: AvatarSlots,
|
||||
events: AvatarEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,7 +1,53 @@
|
|||
const AvatarGroupProps = [
|
||||
{
|
||||
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: 'image',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the image to display.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Size of the element, valid options are "large" and "xlarge".'
|
||||
},
|
||||
{
|
||||
name: 'shape',
|
||||
type: 'string',
|
||||
default: 'square',
|
||||
description: 'Shape of the element, valid options are "square" and "circle".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
avatargroup: {
|
||||
name: 'AvatarGroup',
|
||||
'doc-url': 'avatar',
|
||||
description: 'A set of Avatars can be displayed together using the AvatarGroup component.'
|
||||
description: 'A set of Avatars can be displayed together using the AvatarGroup component.',
|
||||
props: AvatarGroupProps
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
const BadgeProps = [
|
||||
{
|
||||
name: 'value',
|
||||
type: 'any',
|
||||
type: 'string | number',
|
||||
default: 'null',
|
||||
description: 'Value to display inside the badge.'
|
||||
},
|
||||
|
|
@ -16,6 +16,18 @@ const BadgeProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Size of the badge, valid options are "large" and "xlarge".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -22,6 +22,18 @@ const BlockUIProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Whether to automatically manage layering.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,13 +16,33 @@ const BreadcrumbProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const BreadcrumbSlots = [
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom item template.'
|
||||
},
|
||||
{
|
||||
name: 'separator',
|
||||
description: 'Custom separator template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,79 @@ const ButtonProps = [
|
|||
type: 'string',
|
||||
default: 'pi pi-spinner pi-spin',
|
||||
description: 'Icon to display in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'link',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a link style to the button.'
|
||||
},
|
||||
{
|
||||
name: 'severity',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the style of the button, valid values are "secondary", "success", "info", "warning", "help", "danger".'
|
||||
},
|
||||
{
|
||||
name: 'raised',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a shadow to indicate elevation.'
|
||||
},
|
||||
{
|
||||
name: 'rounded',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a circular border radius to the button.'
|
||||
},
|
||||
{
|
||||
name: 'text',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a textual class to the button without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'outlined',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a border class without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the size of the button, valid values are "small" and "large".'
|
||||
},
|
||||
{
|
||||
name: 'plain',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a plain textual class to the button without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const ButtonEvents = [];
|
||||
|
||||
const ButtonSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -53,6 +126,8 @@ module.exports = {
|
|||
button: {
|
||||
name: 'Button',
|
||||
description: 'Button is an extension to standard button element with icons and theming.',
|
||||
props: ButtonProps
|
||||
props: ButtonProps,
|
||||
events: ButtonEvents,
|
||||
slots: ButtonSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -44,9 +44,33 @@ const CalendarProps = [
|
|||
{
|
||||
name: 'icon',
|
||||
type: 'string',
|
||||
default: 'pi pi-calendar',
|
||||
default: 'null',
|
||||
description: 'Icon of the calendar button.'
|
||||
},
|
||||
{
|
||||
name: 'previousIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to show in the previous button.'
|
||||
},
|
||||
{
|
||||
name: 'nextIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to show in the next button.'
|
||||
},
|
||||
{
|
||||
name: 'incrementIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to show in each of the increment buttons.'
|
||||
},
|
||||
{
|
||||
name: 'decrementIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to show in each of the decrement buttons.'
|
||||
},
|
||||
{
|
||||
name: 'numberOfMonths',
|
||||
type: 'number',
|
||||
|
|
@ -219,7 +243,7 @@ const CalendarProps = [
|
|||
name: 'manualInput',
|
||||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Wheter to allow prevents entering the date manually via typing.'
|
||||
description: 'Whether to allow entering the date manually via typing.'
|
||||
},
|
||||
{
|
||||
name: 'appendTo',
|
||||
|
|
@ -259,13 +283,13 @@ const CalendarProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
|
|
@ -273,17 +297,17 @@ const CalendarProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the overlay panel.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
type: 'string',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the overlay panel.'
|
||||
},
|
||||
|
|
@ -291,7 +315,19 @@ const CalendarProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -436,6 +472,26 @@ const CalendarSlots = [
|
|||
{
|
||||
name: 'decade',
|
||||
description: 'Custom content for the calendar decade.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownicon',
|
||||
description: 'Custom dropdown icon template.'
|
||||
},
|
||||
{
|
||||
name: 'previousicon',
|
||||
description: 'Custom previous icon template.'
|
||||
},
|
||||
{
|
||||
name: 'nexticon',
|
||||
description: 'Custom next icon template.'
|
||||
},
|
||||
{
|
||||
name: 'incrementicon',
|
||||
description: 'Custom increment icon template.'
|
||||
},
|
||||
{
|
||||
name: 'decrementicon',
|
||||
description: 'Custom decrement icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,18 @@
|
|||
const CardProps = [
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const CardSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
|
|
@ -25,6 +40,7 @@ module.exports = {
|
|||
card: {
|
||||
name: 'Card',
|
||||
description: 'Card is a flexible container component.',
|
||||
props: CardProps,
|
||||
slots: CardSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -82,10 +82,26 @@ const CarouselProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Whether to display indicator container.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const CarouselSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: 'Custom content for the component header.'
|
||||
},
|
||||
{
|
||||
name: 'header',
|
||||
description: 'Custom content for the component header.'
|
||||
|
|
@ -97,6 +113,14 @@ const CarouselSlots = [
|
|||
{
|
||||
name: 'item',
|
||||
description: 'Custom content for the component item.'
|
||||
},
|
||||
{
|
||||
name: 'previousicon',
|
||||
description: 'Custom previous icon template.'
|
||||
},
|
||||
{
|
||||
name: 'nexticon',
|
||||
description: 'Custom next icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ const CascadeSelectProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -75,7 +75,7 @@ const CascadeSelectProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
|
|
@ -85,7 +85,7 @@ const CascadeSelectProps = [
|
|||
},
|
||||
{
|
||||
name: 'panelClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the overlay panel.'
|
||||
},
|
||||
|
|
@ -93,7 +93,7 @@ const CascadeSelectProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'appendTo',
|
||||
|
|
@ -107,12 +107,24 @@ const CascadeSelectProps = [
|
|||
default: 'false',
|
||||
description: 'Whether the multiselect is in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the dropdown.'
|
||||
},
|
||||
{
|
||||
name: 'loadingIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-spinner pi-spin',
|
||||
default: 'null',
|
||||
description: 'Icon to display in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'optionGroupIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the option group.'
|
||||
},
|
||||
{
|
||||
name: 'autoOptionFocus',
|
||||
type: 'boolean',
|
||||
|
|
@ -172,6 +184,18 @@ const CascadeSelectProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying input element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -262,15 +286,27 @@ const CascadeSelectEvents = [
|
|||
const CascadeSelectSlots = [
|
||||
{
|
||||
name: 'value',
|
||||
description: "Custom content for the item's value"
|
||||
description: "Custom content for the item's value."
|
||||
},
|
||||
{
|
||||
name: 'option',
|
||||
description: "Custom content for the item's option"
|
||||
description: "Custom content for the item's option."
|
||||
},
|
||||
{
|
||||
name: 'indicator',
|
||||
description: 'Custom content for the dropdown indicator'
|
||||
description: 'Custom content for the dropdown indicator.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownicon',
|
||||
description: 'Custom dropdown icon template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'optiongroupicon',
|
||||
description: 'Custom content for the option group icon.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const ChartProps = [
|
|||
type: 'number',
|
||||
default: '150',
|
||||
description: 'Height of the chart in non-responsive mode.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -61,13 +61,13 @@ const CheckboxProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'any',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
|
|
@ -75,7 +75,7 @@ const CheckboxProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'aria-labelledby',
|
||||
|
|
@ -88,6 +88,18 @@ const CheckboxProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -106,11 +118,19 @@ const CheckboxEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const CheckboxSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
checkbox: {
|
||||
name: 'Checkbox',
|
||||
description: 'Checkbox is an extension to standard checkbox element with theming.',
|
||||
props: CheckboxProps,
|
||||
events: CheckboxEvents
|
||||
events: CheckboxEvents,
|
||||
slots: CheckboxSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -28,6 +28,18 @@ const ChipProps = [
|
|||
type: 'string',
|
||||
default: 'pi pi-times-circle',
|
||||
description: 'Icon of the remove element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -45,11 +57,23 @@ const ChipEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const ChipSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template of chip component.'
|
||||
},
|
||||
{
|
||||
name: 'removeicon',
|
||||
description: 'Custom remove icon template of chip component.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
chip: {
|
||||
name: 'Chip',
|
||||
description: 'Chip represents entities using icons, labels and images',
|
||||
props: ChipProps,
|
||||
events: ChipEvents
|
||||
events: ChipEvents,
|
||||
slots: ChipSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -49,13 +49,13 @@ const ChipsProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
|
|
@ -63,7 +63,19 @@ const ChipsProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -106,6 +118,10 @@ const ChipsSlots = [
|
|||
{
|
||||
name: 'chips',
|
||||
description: 'Custom content for the chips'
|
||||
},
|
||||
{
|
||||
name: 'removetokenicon',
|
||||
description: 'Custom remove token icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -70,6 +70,18 @@ const ColorPickerProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -250,6 +250,12 @@ const ColumnProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Whether the column is rendered.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -289,6 +295,62 @@ const ColumnSlots = [
|
|||
{
|
||||
name: 'filterapply',
|
||||
description: "Custom content for the filter menu's apply section"
|
||||
},
|
||||
{
|
||||
name: 'loading',
|
||||
description: 'Custom loading template.'
|
||||
},
|
||||
{
|
||||
name: 'rowtogglericon',
|
||||
description: 'Custom row toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rowtogglericon',
|
||||
description: 'Custom row toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rowcheckboxicon',
|
||||
description: 'Custom row checkbox icon template.'
|
||||
},
|
||||
{
|
||||
name: 'roweditoriniticon',
|
||||
description: 'Custom row editor init icon template.'
|
||||
},
|
||||
{
|
||||
name: 'roweditorsaveicon',
|
||||
description: 'Custom row editor save icon template.'
|
||||
},
|
||||
{
|
||||
name: 'roweditorcancelicon',
|
||||
description: 'Custom row editor cancel icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filtericon',
|
||||
description: 'Custom filter icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filterclearicon',
|
||||
description: 'Custom filter clear icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filterremoveicon',
|
||||
description: 'Custom filter remove icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filteraddicon',
|
||||
description: 'Custom filter add icon template.'
|
||||
},
|
||||
{
|
||||
name: 'sorticon',
|
||||
description: 'Custom sort icon template.'
|
||||
},
|
||||
{
|
||||
name: 'headercheckboxicon',
|
||||
description: 'Custom header checkbox icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rowreordericon',
|
||||
description: 'Custom row reorder icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,23 @@
|
|||
const ColumnGroupProps = [
|
||||
{
|
||||
name: 'type',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the type of the group.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
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'
|
||||
'doc-url': 'datatable',
|
||||
props: ColumnGroupProps
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -10,13 +10,43 @@ const ConfirmDialogProps = [
|
|||
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: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const ConfirmDialogSlots = [
|
||||
{
|
||||
name: 'message',
|
||||
description: 'Custom content for the component.'
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'accepticon',
|
||||
description: 'Custom accept icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rejecticon',
|
||||
description: 'Custom reject icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,18 @@ const ConfirmPopupProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -11,6 +23,18 @@ const ConfirmPopupSlots = [
|
|||
{
|
||||
name: 'message',
|
||||
description: 'Custom content for the component.'
|
||||
},
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'accepticon',
|
||||
description: 'Custom accept icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rejecticon',
|
||||
description: 'Custom reject icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,13 +34,33 @@ const ContextMenuProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const ContextMenuSlots = [
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom item template.'
|
||||
},
|
||||
{
|
||||
name: 'submenuicon',
|
||||
description: 'Custom submenu icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -366,6 +366,12 @@ const DataTableProps = [
|
|||
default: 'false',
|
||||
description: 'Whether to displays rows with alternating colors.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the size of the table.'
|
||||
},
|
||||
{
|
||||
name: 'tableStyle',
|
||||
type: 'object',
|
||||
|
|
@ -377,6 +383,18 @@ const DataTableProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Style class of the table element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -1120,31 +1138,67 @@ const DataTableEvents = [
|
|||
const DataTableSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'paginatorstart',
|
||||
description: "Custom content for the component paginator's left side"
|
||||
description: "Custom content for the component paginator's left side."
|
||||
},
|
||||
{
|
||||
name: 'paginatorend',
|
||||
description: "Custom content for the component paginator's right side"
|
||||
description: "Custom content for the component paginator's right side."
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'groupheader',
|
||||
description: "Custom content for the component's subgroup header"
|
||||
description: "Custom content for the component's subgroup header."
|
||||
},
|
||||
{
|
||||
name: 'groupfooter',
|
||||
description: "Custom content for the component's subgroup footer"
|
||||
description: "Custom content for the component's subgroup footer."
|
||||
},
|
||||
{
|
||||
name: 'expansion',
|
||||
description: "Custom content for the component's expanded content"
|
||||
name: 'loading',
|
||||
description: 'Custom loading template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'reorderindicatorupicon',
|
||||
description: 'Custom reorder indicator up icon template.'
|
||||
},
|
||||
{
|
||||
name: 'reorderindicatordownicon',
|
||||
description: 'Custom reorder indicator down icon template.'
|
||||
},
|
||||
{
|
||||
name: 'rowgrouptogglericon',
|
||||
description: 'Custom rowgroup toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorfirstpagelinkicon',
|
||||
description: 'Custom paginator first page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorprevpagelinkicon',
|
||||
description: 'Custom paginator prev page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatornextpagelinkicon',
|
||||
description: 'Custom paginator next page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorlastpagelinkicon',
|
||||
description: 'Custom paginator last page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'empty',
|
||||
description: 'Custom empty template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -94,6 +94,18 @@ const DataViewProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Name of the data that uniquely identifies the a record in the data.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,35 @@
|
|||
const DataViewLayoutOptionsProps = [
|
||||
{
|
||||
name: 'modelValue',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Value of the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
const DataViewLayoutOptionsSlots = [
|
||||
{
|
||||
name: 'listicon',
|
||||
description: 'Custom list icon template.'
|
||||
},
|
||||
{
|
||||
name: 'gridicon',
|
||||
description: 'Custom grid icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
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'
|
||||
'doc-url': 'dataview',
|
||||
props: DataViewLayoutOptionsProps,
|
||||
slots: DataViewLayoutOptionsSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,3 +1,18 @@
|
|||
const DeferredContentProps = [
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const DeferredContentEvents = [
|
||||
{
|
||||
name: 'load',
|
||||
|
|
@ -16,6 +31,7 @@ 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.',
|
||||
props: DeferredContentProps,
|
||||
events: DeferredContentEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -130,6 +130,18 @@ const DialogProps = [
|
|||
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: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -189,6 +201,14 @@ const DialogSlots = [
|
|||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
},
|
||||
{
|
||||
name: 'maximizeicon',
|
||||
description: 'Custom maximizeicon icon template of dialog.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const DividerProps = [
|
|||
type: 'string',
|
||||
default: 'solid',
|
||||
description: 'Border style type, default is "solid" and other options are "dashed" and "dotted".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const DockProps = [
|
|||
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'."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ const DropdownProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -129,7 +129,7 @@ const DropdownProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement/HTMLSpanElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
|
|
@ -147,19 +147,19 @@ const DropdownProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLElement to the clear icon inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'appendTo',
|
||||
|
|
@ -256,6 +256,18 @@ const DropdownProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying input element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -372,6 +384,22 @@ const DropdownSlots = [
|
|||
{
|
||||
name: 'loader',
|
||||
description: 'Custom content for the virtual scroller loader items'
|
||||
},
|
||||
{
|
||||
name: 'clearicon',
|
||||
description: 'Custom clear icon template.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownicon',
|
||||
description: 'Custom dropdown icon template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filtericon',
|
||||
description: 'Custom filter icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const EditorProps = [
|
|||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Modules configuration, see <a href="http://quilljs.com/docs/modules/">here</a> for available options.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,19 @@ const FieldsetProps = [
|
|||
name: 'toggleButtonProps',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Uses to pass the custom value to read for the anchor inside the component.'
|
||||
description: 'Used to pass the custom value to read for the AnchorHTMLAttributes inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -47,7 +59,11 @@ const FieldsetEvents = [
|
|||
const FieldsetSlots = [
|
||||
{
|
||||
name: 'legend',
|
||||
description: "Custom content for the component's header"
|
||||
description: 'Custom legend template.'
|
||||
},
|
||||
{
|
||||
name: 'togglericon',
|
||||
description: 'Custom toggler icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -142,6 +142,18 @@ const FileUploadProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Style class of the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -276,9 +288,33 @@ const FileUploadEvents = [
|
|||
];
|
||||
|
||||
const FileUploadSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: 'Custom header template.'
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
description: 'Custom content template.'
|
||||
},
|
||||
{
|
||||
name: 'empty',
|
||||
description: 'Custom content when there is no selected file'
|
||||
},
|
||||
{
|
||||
name: 'chooseicon',
|
||||
description: 'Custom choose icon template.'
|
||||
},
|
||||
{
|
||||
name: 'uploadicon',
|
||||
description: 'Custom upload icon template.'
|
||||
},
|
||||
{
|
||||
name: 'cancelicon',
|
||||
description: 'Custom cancel icon template.'
|
||||
},
|
||||
{
|
||||
name: 'fileremoveicon',
|
||||
description: 'Custom remove icon template for each file.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,22 +0,0 @@
|
|||
const FullCalendarProps = [
|
||||
{
|
||||
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.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
fullcalendar: {
|
||||
name: 'FullCalendar',
|
||||
description: 'An event calendar based on the FullCalendar library.',
|
||||
props: FullCalendarProps
|
||||
}
|
||||
};
|
||||
|
|
@ -142,33 +142,65 @@ const GalleriaProps = [
|
|||
type: 'any',
|
||||
default: 'null',
|
||||
description: "Style class of the component on fullscreen mode. Otherwise, the 'class' property can be used."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const GalleriaSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Custom content for the item'
|
||||
description: 'Custom content for the item.'
|
||||
},
|
||||
{
|
||||
name: 'caption',
|
||||
description: 'Custom caption content'
|
||||
description: 'Custom caption content.'
|
||||
},
|
||||
{
|
||||
name: 'thumbnail',
|
||||
description: 'Custom thumbnail content'
|
||||
description: 'Custom thumbnail content.'
|
||||
},
|
||||
{
|
||||
name: 'indicator',
|
||||
description: 'Custom indicator content'
|
||||
description: 'Custom indicator content.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
},
|
||||
{
|
||||
name: 'previousitemicon',
|
||||
description: 'Custom navigator previous item icon template.'
|
||||
},
|
||||
{
|
||||
name: 'nextitemicon',
|
||||
description: 'Custom navigator next item icon template.'
|
||||
},
|
||||
{
|
||||
name: 'previousthumbnailicon',
|
||||
description: 'Custom thumbnail previous icon template.'
|
||||
},
|
||||
{
|
||||
name: 'nextthumbnailicon',
|
||||
description: 'Custom thumbnail next icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,36 @@ const ImageProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Controls the preview functionality.'
|
||||
},
|
||||
{
|
||||
name: 'indicatorIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-eye',
|
||||
description: 'Custom indicator icon.'
|
||||
},
|
||||
{
|
||||
name: 'zoomInDisabled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Disable the zoom-in button'
|
||||
},
|
||||
{
|
||||
name: 'zoomOutDisabled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Disable the zoom-out button'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -25,7 +55,35 @@ const ImageEvents = [
|
|||
const ImageSlots = [
|
||||
{
|
||||
name: 'indicator',
|
||||
description: 'Custom content for the preview indicator'
|
||||
description: 'Custom content for the preview indicator.'
|
||||
},
|
||||
{
|
||||
name: 'refresh',
|
||||
description: 'Custom content for the component refresh.'
|
||||
},
|
||||
{
|
||||
name: 'undo',
|
||||
description: 'Custom content for the component undo.'
|
||||
},
|
||||
{
|
||||
name: 'zoomout',
|
||||
description: 'Custom content for the component zoomout.'
|
||||
},
|
||||
{
|
||||
name: 'zoomin',
|
||||
description: 'Custom content for the component zoomin.'
|
||||
},
|
||||
{
|
||||
name: 'close',
|
||||
description: 'Custom content for the component close.'
|
||||
},
|
||||
{
|
||||
name: 'image',
|
||||
description: 'Custom content for the component image.'
|
||||
},
|
||||
{
|
||||
name: 'preview',
|
||||
description: 'Custom content for the component preview.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,31 @@ const InlineMessageProps = [
|
|||
type: 'string',
|
||||
default: 'error',
|
||||
description: 'Severity level of the message. Valid severities are "success", "info", "warn" and "error".'
|
||||
},
|
||||
{
|
||||
name: 'icon',
|
||||
type: 'string',
|
||||
default: 'undefined',
|
||||
description: 'Display a custom icon for the message.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const MessageSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -12,6 +37,7 @@ module.exports = {
|
|||
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
|
||||
props: InlineMessageProps,
|
||||
slots: MessageSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const InplaceProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When present, it specifies that the element should be disabled.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -47,11 +59,15 @@ const InplaceEvents = [
|
|||
const InplaceSlots = [
|
||||
{
|
||||
name: 'display',
|
||||
description: 'Output content'
|
||||
description: 'Custom display template.'
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
description: 'Actual content'
|
||||
description: 'Custom content template.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,18 @@ const InputMaskProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Defines if model sets the raw unmasked value to bound value or the formatted mask value.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -155,13 +155,13 @@ const InputNumberProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -169,19 +169,31 @@ const InputNumberProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLButtonElement to decrement button inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -231,11 +243,23 @@ const InputNumberEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const InputNumberSlots = [
|
||||
{
|
||||
name: 'incrementbuttonicon',
|
||||
description: 'Custom increment button icon template.'
|
||||
},
|
||||
{
|
||||
name: 'decrementbuttonicon',
|
||||
description: 'Custom decrement button icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
inputnumber: {
|
||||
name: 'InputNumber',
|
||||
description: 'InputNumber is an input component to provide numerical input.',
|
||||
props: InputNumberProps,
|
||||
events: InputNumberEvents
|
||||
events: InputNumberEvents,
|
||||
slots: InputNumberSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -25,13 +25,13 @@ const InputSwitchProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -39,7 +39,19 @@ const InputSwitchProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,24 @@ const InputTextProps = [
|
|||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Value of the component.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the size of the component, valid values are "small" and "large".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -94,6 +94,18 @@ const KnobProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ const ListboxProps = [
|
|||
name: 'filterInputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the filter input inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the filter input inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'virtualScrollerOptions',
|
||||
|
|
@ -173,6 +173,18 @@ const ListboxProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying input element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -236,35 +248,39 @@ const ListboxEvents = [
|
|||
const ListboxSlots = [
|
||||
{
|
||||
name: 'option',
|
||||
description: "Custom content for the item's option"
|
||||
description: "Custom content for the item's option."
|
||||
},
|
||||
{
|
||||
name: 'optiongroup',
|
||||
description: "Custom content for the item's optiongroup"
|
||||
description: "Custom content for the item's optiongroup."
|
||||
},
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'emptyfilter',
|
||||
description: 'Custom content when there is no filtered data to display'
|
||||
description: 'Custom content when there is no filtered data to display.'
|
||||
},
|
||||
{
|
||||
name: 'empty',
|
||||
description: 'Custom content when there is no data to display'
|
||||
description: 'Custom content when there is no data to display.'
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
description: 'Custom content for the virtual scroller'
|
||||
description: 'Custom content for the virtual scroller.'
|
||||
},
|
||||
{
|
||||
name: 'loader',
|
||||
description: 'Custom content for the virtual scroller loader items'
|
||||
description: 'Custom content for the virtual scroller loader items.'
|
||||
},
|
||||
{
|
||||
name: 'filtericon',
|
||||
description: 'Custom filter icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const MegaMenuProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -30,7 +42,15 @@ const MegaMenuSlots = [
|
|||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom item template.'
|
||||
},
|
||||
{
|
||||
name: 'submenuicon',
|
||||
description: 'Custom submenu icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const MenuProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -49,9 +61,25 @@ const MenuEvents = [
|
|||
];
|
||||
|
||||
const MenuSlots = [
|
||||
{
|
||||
name: 'start',
|
||||
description: 'Custom content before the content'
|
||||
},
|
||||
{
|
||||
name: 'end',
|
||||
description: 'Custom content after the content'
|
||||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom item template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
},
|
||||
{
|
||||
name: 'submenuheader',
|
||||
description: 'Custom submenuheader template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -10,21 +10,45 @@ const MenubarProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const MenubarSlots = [
|
||||
{
|
||||
name: 'start',
|
||||
description: 'Custom content before the content'
|
||||
description: 'Custom content before the content.'
|
||||
},
|
||||
{
|
||||
name: 'end',
|
||||
description: 'Custom content after the content'
|
||||
description: 'Custom content after the content.'
|
||||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom menuitem template.'
|
||||
},
|
||||
{
|
||||
name: 'baricon',
|
||||
description: 'Custom bar icon template.'
|
||||
},
|
||||
{
|
||||
name: 'submenuicon',
|
||||
description: 'Custom submenu icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -26,8 +26,37 @@ const MessageProps = [
|
|||
{
|
||||
name: 'icon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
default: 'undefined',
|
||||
description: 'Display a custom icon for the message.'
|
||||
},
|
||||
{
|
||||
name: 'closeIcon',
|
||||
type: 'string',
|
||||
default: 'undefined',
|
||||
description: 'Display a custom close icon for the message.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const MessageSlots = [
|
||||
{
|
||||
name: 'messageicon',
|
||||
description: 'Custom message icon template.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -50,6 +79,7 @@ module.exports = {
|
|||
name: 'Message',
|
||||
description: 'Messages is used to display inline messages with various severities.',
|
||||
props: MessageProps,
|
||||
slots: MessageSlots,
|
||||
events: MessageEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ const MultiSelectProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
|
|
@ -87,19 +87,19 @@ const MultiSelectProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLButtonElement to the close button inside the overlay panel.'
|
||||
},
|
||||
{
|
||||
name: 'dataKey',
|
||||
|
|
@ -182,9 +182,39 @@ const MultiSelectProps = [
|
|||
{
|
||||
name: 'loadingIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-spinner pi-spin',
|
||||
default: 'null',
|
||||
description: 'Icon to display in loading state.'
|
||||
},
|
||||
{
|
||||
name: 'checkboxIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the checkboxes.'
|
||||
},
|
||||
{
|
||||
name: 'closeIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the dropdown close button.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in the dropdown.'
|
||||
},
|
||||
{
|
||||
name: 'filterIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in filter input.'
|
||||
},
|
||||
{
|
||||
name: 'removeTokenIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon to display in chip remove action.'
|
||||
},
|
||||
{
|
||||
name: 'selectAll',
|
||||
type: 'boolean',
|
||||
|
|
@ -262,6 +292,18 @@ const MultiSelectProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying input element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -357,7 +399,7 @@ const MultiSelectEvents = [
|
|||
const MultiSelectSlots = [
|
||||
{
|
||||
name: 'value',
|
||||
description: 'Custom content for the item value'
|
||||
description: 'Custom content for the item value.'
|
||||
},
|
||||
{
|
||||
name: 'chip',
|
||||
|
|
@ -365,39 +407,67 @@ const MultiSelectSlots = [
|
|||
},
|
||||
{
|
||||
name: 'indicator',
|
||||
description: 'Custom content for the dropdown indicator'
|
||||
description: 'Custom content for the dropdown indicator.'
|
||||
},
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'option',
|
||||
description: "Custom content for the item's option"
|
||||
description: "Custom content for the item's option."
|
||||
},
|
||||
{
|
||||
name: 'optiongroup',
|
||||
description: "Custom content for the item's optiongroup"
|
||||
description: "Custom content for the item's optiongroup."
|
||||
},
|
||||
{
|
||||
name: 'emptyfilter',
|
||||
description: 'Custom content when there is no filtered data to display'
|
||||
description: 'Custom content when there is no filtered data to display.'
|
||||
},
|
||||
{
|
||||
name: 'empty',
|
||||
description: 'Custom content when there is no data to display'
|
||||
description: 'Custom content when there is no data to display.'
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
description: 'Custom content for the virtual scroller'
|
||||
description: 'Custom content for the virtual scroller.'
|
||||
},
|
||||
{
|
||||
name: 'loader',
|
||||
description: 'Custom content for the virtual scroller loader items'
|
||||
description: 'Custom content for the virtual scroller loader items.'
|
||||
},
|
||||
{
|
||||
name: 'removetokenicon',
|
||||
description: 'Custom remove token icon template.'
|
||||
},
|
||||
{
|
||||
name: 'headercheckboxicon',
|
||||
description: 'Custom header checkbox icon template.'
|
||||
},
|
||||
{
|
||||
name: 'filtericon',
|
||||
description: 'Custom filter icon template.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemcheckboxicon',
|
||||
description: 'Custom item checkbox icon template.'
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'dropdownicon',
|
||||
description: 'Custom dropdown icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -47,6 +47,18 @@ const OrderListProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Whether to displays rows with alternating colors.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -93,19 +105,35 @@ const OrderListEvents = [
|
|||
const OrderListSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Custom content for the item'
|
||||
description: 'Custom content for the item.'
|
||||
},
|
||||
{
|
||||
name: 'controlsstart',
|
||||
description: 'Custom content before the buttons'
|
||||
description: 'Custom content before the buttons.'
|
||||
},
|
||||
{
|
||||
name: 'controlsend',
|
||||
description: 'Custom content after the buttons'
|
||||
description: 'Custom content after the buttons.'
|
||||
},
|
||||
{
|
||||
name: 'movetopicon',
|
||||
description: 'Custom move top icon template.'
|
||||
},
|
||||
{
|
||||
name: 'moveupicon',
|
||||
description: 'Custom move up icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movedownicon',
|
||||
description: 'Custom move down icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movebottomicon',
|
||||
description: 'Custom move bottom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,18 @@ const OrganizationChartProps = [
|
|||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'A map instance of key-value pairs to represented the collapsed nodes.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -78,11 +90,19 @@ const OrganizationChartEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const OrganizationChartSlots = [
|
||||
{
|
||||
name: 'togglericon',
|
||||
description: 'Custom toggler icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
organizationchart: {
|
||||
name: 'OrganizationChart',
|
||||
description: 'OrganizationChart visualizes hierarchical organization data.',
|
||||
props: OrganizationChartProps,
|
||||
events: OrganizationChartEvents
|
||||
events: OrganizationChartEvents,
|
||||
slots: OrganizationChartSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -40,6 +40,31 @@ const OverlayPanelProps = [
|
|||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Object literal to define widths per screen size.'
|
||||
},
|
||||
{
|
||||
name: 'closeIcon',
|
||||
type: 'string',
|
||||
default: 'undefined',
|
||||
description: 'Display a custom close icon for the message.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const OverlayPanelSlots = [
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -59,6 +84,7 @@ module.exports = {
|
|||
name: 'OverlayPanel',
|
||||
description: 'OverlayPanel is a container component positioned as connected to its target.',
|
||||
props: OverlayPanelProps,
|
||||
slots: OverlayPanelSlots,
|
||||
events: OverlayPanelEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -46,6 +46,18 @@ const PaginatorProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Whether to show the paginator even there is only one page.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -80,12 +92,28 @@ const PaginatorEvents = [
|
|||
|
||||
const PaginatorSlots = [
|
||||
{
|
||||
name: 'left',
|
||||
description: "Custom content for the component's left side"
|
||||
name: 'start',
|
||||
description: "Custom content for the component's left side."
|
||||
},
|
||||
{
|
||||
name: 'right',
|
||||
description: "Custom content for the component's right side"
|
||||
name: 'end',
|
||||
description: "Custom content for the component's right side."
|
||||
},
|
||||
{
|
||||
name: 'firstpagelinkicon',
|
||||
description: 'Custom first page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'prevpagelinkicon',
|
||||
description: 'Custom previous page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'nextpagelinkicon',
|
||||
description: 'Custom next page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'lastpagelinkicon',
|
||||
description: 'Custom last page link icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,19 @@ const PanelProps = [
|
|||
name: 'toggleButtonProps',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Uses to pass the custom value to read for the anchor inside the component.'
|
||||
description: 'Used to pass the custom value to read for the anchor inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -47,11 +59,19 @@ const PanelEvents = [
|
|||
const PanelSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'icons',
|
||||
description: "Custom content for the header's icon"
|
||||
description: "Custom content for the header's icon."
|
||||
},
|
||||
{
|
||||
name: 'togglericon',
|
||||
description: "Custom content for the component's toggler icon."
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer."
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,13 +16,37 @@ const PanelMenuProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const PanelMenuSlots = [
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
description: 'Custom item template.'
|
||||
},
|
||||
{
|
||||
name: 'submenuicon',
|
||||
description: 'Custom submenu icon template.'
|
||||
},
|
||||
{
|
||||
name: 'headericon',
|
||||
description: 'Custom header icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -68,13 +68,13 @@ const PasswordProps = [
|
|||
{
|
||||
name: 'hideIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-eye-slash',
|
||||
default: 'null',
|
||||
description: 'Icon to hide displaying the password as plain text.'
|
||||
},
|
||||
{
|
||||
name: 'showIcon',
|
||||
type: 'string',
|
||||
default: 'pi pi-eye',
|
||||
default: 'null',
|
||||
description: 'Icon to show displaying the password as plain text.'
|
||||
},
|
||||
{
|
||||
|
|
@ -97,13 +97,13 @@ const PasswordProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'any',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -111,7 +111,7 @@ const PasswordProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'panelId',
|
||||
|
|
@ -121,13 +121,13 @@ const PasswordProps = [
|
|||
},
|
||||
{
|
||||
name: 'panelClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the overlay panel.'
|
||||
},
|
||||
{
|
||||
name: 'panelStyle',
|
||||
type: 'string',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the overlay panel.'
|
||||
},
|
||||
|
|
@ -135,22 +135,56 @@ const PasswordProps = [
|
|||
name: 'panelProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the overlay panel inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const PasswordSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
description: 'Custom content for the component'
|
||||
description: 'Custom content for the component.'
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'hideicon',
|
||||
description: 'Custom content for the hide icon.'
|
||||
},
|
||||
{
|
||||
name: 'showicon',
|
||||
description: 'Custom content for the show icon.'
|
||||
}
|
||||
];
|
||||
|
||||
const PasswordEmits = [
|
||||
{
|
||||
name: 'change',
|
||||
description: 'Callback to invoke on value change.',
|
||||
arguments: [
|
||||
{
|
||||
name: 'event',
|
||||
type: 'object',
|
||||
description: 'Browser event'
|
||||
}
|
||||
]
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -159,6 +193,7 @@ module.exports = {
|
|||
name: 'Password',
|
||||
description: 'Password displays strength indicator for password fields.',
|
||||
props: PasswordProps,
|
||||
slots: PasswordSlots
|
||||
slots: PasswordSlots,
|
||||
events: PasswordEmits
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -59,6 +59,18 @@ const PickListProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Whether to show buttons of target list.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -172,41 +184,77 @@ const PickListEvents = [
|
|||
];
|
||||
|
||||
const PickListSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: 'Custom header template.'
|
||||
},
|
||||
{
|
||||
name: 'sourceheader',
|
||||
description: "Custom content for the component's source header"
|
||||
description: "Custom content for the component's source header."
|
||||
},
|
||||
{
|
||||
name: 'item',
|
||||
description: 'Custom content for the item'
|
||||
description: 'Custom content for the item.'
|
||||
},
|
||||
{
|
||||
name: 'targetheader',
|
||||
description: "Custom content for the component's target header"
|
||||
description: "Custom content for the component's target header."
|
||||
},
|
||||
{
|
||||
name: 'sourcecontrolsstart',
|
||||
description: 'Custom content before source control buttons'
|
||||
description: 'Custom content before source control buttons.'
|
||||
},
|
||||
{
|
||||
name: 'sourcecontrolsend',
|
||||
description: 'Custom content after source control buttons'
|
||||
description: 'Custom content after source control buttons.'
|
||||
},
|
||||
{
|
||||
name: 'movecontrolsstart',
|
||||
description: 'Custom content before move buttons'
|
||||
description: 'Custom content before move buttons.'
|
||||
},
|
||||
{
|
||||
name: 'movecontrolsend',
|
||||
description: 'Custom content after move buttons'
|
||||
description: 'Custom content after move buttons.'
|
||||
},
|
||||
{
|
||||
name: 'targetcontrolsstart',
|
||||
description: 'Custom content before target control buttons'
|
||||
description: 'Custom content before target control buttons.'
|
||||
},
|
||||
{
|
||||
name: 'targetcontrolsend',
|
||||
description: 'Custom content after target control buttons'
|
||||
description: 'Custom content after target control buttons.'
|
||||
},
|
||||
{
|
||||
name: 'moveupicon',
|
||||
description: 'Custom move up icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movetopicon',
|
||||
description: 'Custom move top icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movedownicon',
|
||||
description: 'Custom move down icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movebottomicon',
|
||||
description: 'Custom move bottom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movetotargeticon',
|
||||
description: 'Custom move to target icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movealltotargeticon',
|
||||
description: 'Custom move all to target icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movetosourceicon',
|
||||
description: 'Custom move to source icon template.'
|
||||
},
|
||||
{
|
||||
name: 'movealltosourceicon',
|
||||
description: 'Custom move all to source icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const ProgressbarProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'Whether to display the progress bar value.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const ProgressSpinnerProps = [
|
|||
type: 'string',
|
||||
default: '2s',
|
||||
description: 'Duration of the rotate animation.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -31,13 +31,13 @@ const RadioButtonProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
|
|
@ -45,7 +45,7 @@ const RadioButtonProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'aria-labelledby',
|
||||
|
|
@ -58,6 +58,18 @@ const RadioButtonProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,51 @@ const RatingProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: 'When specified a cancel icon is displayed to allow clearing the value.'
|
||||
},
|
||||
{
|
||||
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: 'cancelIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon for the cancelable state.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const RatingSlots = [
|
||||
{
|
||||
name: 'cancelicon',
|
||||
description: 'Custom cancel icon template.'
|
||||
},
|
||||
{
|
||||
name: 'onicon',
|
||||
description: 'Custom on icon template.'
|
||||
},
|
||||
{
|
||||
name: 'officon',
|
||||
description: 'Custom off icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -55,6 +100,7 @@ module.exports = {
|
|||
name: 'rating',
|
||||
description: 'Rating component is a star based selection input.',
|
||||
props: RatingProps,
|
||||
slots: RatingSlots,
|
||||
events: RatingEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,7 +1,23 @@
|
|||
const RowProps = [
|
||||
{
|
||||
name: 'type',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the type of the group.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
row: {
|
||||
name: 'Row',
|
||||
description: 'DataTable can be grouped by defining a Row component with nested columns',
|
||||
'doc-url': 'datatable'
|
||||
'doc-url': 'datatable',
|
||||
props: RowProps
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -4,6 +4,18 @@ const ScrollPanelProps = [
|
|||
type: 'number',
|
||||
default: '5',
|
||||
description: 'Step factor to scroll the content while pressing the arrow keys.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ const ScrollTopProps = [
|
|||
{
|
||||
name: 'icon',
|
||||
type: 'string',
|
||||
default: 'pi pi-chevron-up',
|
||||
default: 'undefined',
|
||||
description: 'Icon to display.'
|
||||
},
|
||||
{
|
||||
|
|
@ -22,6 +22,25 @@ const ScrollTopProps = [
|
|||
type: 'string',
|
||||
default: 'smooth',
|
||||
description: 'Defines the scrolling behavi, "smooth" adds an animation and "auto" scrolls with a jump.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const ScrollTopSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom scrolltop icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -29,6 +48,7 @@ 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.',
|
||||
props: ScrollTopProps
|
||||
props: ScrollTopProps,
|
||||
slots: ScrollTopSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ const SelectButtonProps = [
|
|||
{
|
||||
name: 'unselectable',
|
||||
type: 'boolean',
|
||||
default: 'true',
|
||||
default: 'false',
|
||||
description: 'Whether selection can be cleared.'
|
||||
},
|
||||
{
|
||||
|
|
@ -58,6 +58,18 @@ const SelectButtonProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Identifier of the underlying element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -52,6 +52,24 @@ const SidebarProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Whether background scroll should be blocked when sidebar is visible.'
|
||||
},
|
||||
{
|
||||
name: 'closeIcon',
|
||||
type: 'string',
|
||||
default: 'undefined',
|
||||
description: 'Icon to display in the sidebar close button.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -63,6 +81,10 @@ const SidebarEvents = [
|
|||
{
|
||||
name: 'show',
|
||||
description: 'Callback to invoke when sidebar gets shown.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -70,6 +92,10 @@ const SidebarSlots = [
|
|||
{
|
||||
name: 'header',
|
||||
description: 'Custom content for the component header.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const SkeletonProps = [
|
|||
type: 'string',
|
||||
default: 'wave',
|
||||
description: 'Type of the animation, valid options are "wave" and "none".'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -58,6 +58,18 @@ const SliderProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -106,6 +106,18 @@ const SpeedDialProps = [
|
|||
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'."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -137,8 +149,12 @@ const SpeedDialSlots = [
|
|||
description: 'Custom content for the item'
|
||||
},
|
||||
{
|
||||
name: 'toggle',
|
||||
description: 'toggle: toggle metadata'
|
||||
name: 'button',
|
||||
description: 'Custom button template.'
|
||||
},
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -58,6 +58,60 @@ const SplitButtonProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Name of the menu button icon.'
|
||||
},
|
||||
{
|
||||
name: 'severity',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the style of the button, valid values are "secondary", "success", "info", "warning", "help", "danger".'
|
||||
},
|
||||
{
|
||||
name: 'raised',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a shadow to indicate elevation.'
|
||||
},
|
||||
{
|
||||
name: 'rounded',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a circular border radius to the button.'
|
||||
},
|
||||
{
|
||||
name: 'text',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a textual class to the button without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'outlined',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a border class without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the size of the button, valid values are "small" and "large".'
|
||||
},
|
||||
{
|
||||
name: 'plain',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'Add a plain textual class to the button without a background initially.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -75,11 +129,27 @@ const SplitButtonEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const SplitButtonSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'menubuttonicon',
|
||||
description: 'Custom menu button icon template.'
|
||||
},
|
||||
{
|
||||
name: 'menuitemicon',
|
||||
description: 'Custom menu item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
splitbutton: {
|
||||
name: 'SplitButton',
|
||||
description: 'SplitButton groups a set of commands in an overlay with a default command.',
|
||||
props: SplitButtonProps,
|
||||
events: SplitButtonEvents
|
||||
events: SplitButtonEvents,
|
||||
slots: SplitButtonSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -28,6 +28,18 @@ const SplitterProps = [
|
|||
type: 'number',
|
||||
default: '5',
|
||||
description: 'Step factor to increment/decrement the size of the panels while pressing the arrow keys.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,12 @@ const SplitterPanelProps = [
|
|||
type: 'number',
|
||||
default: 'null',
|
||||
description: 'Minimum size of the element relative to 100%.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -22,6 +22,18 @@ const StepsProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,18 @@ const TabMenuProps = [
|
|||
type: 'number',
|
||||
default: '0',
|
||||
description: 'Active index of menuitem.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -42,6 +54,10 @@ const TabMenuSlots = [
|
|||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -21,13 +21,13 @@ const TabPanelProps = [
|
|||
name: 'headerProps',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLLiElement to the tab header.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.'
|
||||
},
|
||||
{
|
||||
name: 'contentStyle',
|
||||
|
|
@ -45,13 +45,19 @@ const TabPanelProps = [
|
|||
name: 'contentProps',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLDivElement to the tab content.'
|
||||
description: 'Used to pass all properties of the HTMLDivElement to the tab content.'
|
||||
},
|
||||
{
|
||||
name: 'disabled',
|
||||
type: 'boolean',
|
||||
default: 'null',
|
||||
description: 'Whether the tab is disabled.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -33,13 +33,37 @@ const TabViewProps = [
|
|||
name: 'previousButtonProps',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLButtonElement to the previous button.'
|
||||
description: 'Used 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.'
|
||||
description: 'Used to pass all properties of the HTMLButtonElement to the next button.'
|
||||
},
|
||||
{
|
||||
name: 'prevIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Prev icon of the scrollable tabview.'
|
||||
},
|
||||
{
|
||||
name: 'nextIcon',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Next icon of the scrollable tabview.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -78,11 +102,27 @@ const TabViewEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const TabViewSlots = [
|
||||
{
|
||||
name: 'default',
|
||||
description: 'Default slot to detect TabPanel components.'
|
||||
},
|
||||
{
|
||||
name: 'previcon',
|
||||
description: 'Previous button icon template for the scrollable component.'
|
||||
},
|
||||
{
|
||||
name: 'nexticon',
|
||||
description: 'Next button icon template for the scrollable component.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
tabview: {
|
||||
name: 'TabView',
|
||||
description: 'TabView is a container component to group content with tabs.',
|
||||
props: TabViewProps,
|
||||
event: TabViewEvents
|
||||
event: TabViewEvents,
|
||||
slots: TabViewSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -22,6 +22,25 @@ const TagProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Icon of the tag to display next to the value.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const TagSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -29,6 +48,7 @@ module.exports = {
|
|||
tag: {
|
||||
name: 'Tag',
|
||||
description: 'Tag component is used to categorize content.',
|
||||
props: TagProps
|
||||
props: TagProps,
|
||||
slots: TagSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -10,6 +10,18 @@ const TerminalProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Prompt text for each command.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,18 @@ const TextareaProps = [
|
|||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When present, height of textarea changes as being typed.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const TieredMenuProps = [
|
|||
type: 'boolean',
|
||||
default: 'true',
|
||||
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -41,6 +53,14 @@ const TieredMenuSlots = [
|
|||
{
|
||||
name: 'item',
|
||||
description: 'Template of a menuitem.'
|
||||
},
|
||||
{
|
||||
name: 'submenuicon',
|
||||
description: 'Custom submenu icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemicon',
|
||||
description: 'Custom item icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -22,6 +22,18 @@ const TimelineProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Name of the field that uniquely identifies the a record in the data.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,43 @@ const ToastProps = [
|
|||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Object literal to define widths per screen size.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
const ToastEvents = [
|
||||
{
|
||||
name: 'close',
|
||||
description: 'Callback to invoke when the toast is closed.',
|
||||
arguments: [
|
||||
{
|
||||
name: 'message',
|
||||
type: 'any',
|
||||
description: 'Message of toast.'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
name: 'life-end',
|
||||
description: 'Callback to invoke when the toast timeout is over.',
|
||||
arguments: [
|
||||
{
|
||||
name: 'message',
|
||||
type: 'any',
|
||||
description: 'Message of toast.'
|
||||
}
|
||||
]
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -35,6 +72,14 @@ const ToastSlots = [
|
|||
{
|
||||
name: 'message',
|
||||
description: 'Custom content for the toast message'
|
||||
},
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'Custom icon template.'
|
||||
},
|
||||
{
|
||||
name: 'closeicon',
|
||||
description: 'Custom close icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -43,6 +88,7 @@ module.exports = {
|
|||
name: 'Toast',
|
||||
description: 'Toast is used to display messages in an overlay.',
|
||||
props: ToastProps,
|
||||
events: ToastEvents,
|
||||
slots: ToastSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -55,13 +55,13 @@ const ToggleButtonProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
|
|
@ -69,7 +69,19 @@ const ToggleButtonProps = [
|
|||
name: 'inputProps',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
description: 'Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -109,11 +121,19 @@ const ToggleButtonEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const ToggleButtonSlots = [
|
||||
{
|
||||
name: 'icon',
|
||||
description: 'custom icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
togglebutton: {
|
||||
name: 'ToggleButton',
|
||||
description: 'ToggleButton is used to select a boolean value using a button.',
|
||||
props: ToggleButtonProps,
|
||||
slots: ToggleButtonSlots,
|
||||
events: ToggleButtonEvents
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -4,6 +4,18 @@ const ToolbarProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines a string value that labels an interactive element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -15,6 +27,10 @@ const ToolbarSlots = [
|
|||
{
|
||||
name: 'end',
|
||||
description: "Custom content for the component's right side"
|
||||
},
|
||||
{
|
||||
name: 'center',
|
||||
description: "Custom content for the component's center"
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -77,6 +77,18 @@ const TreeProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Height of the scroll viewport in fixed units or the "flex" keyword for a dynamic size.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -127,11 +139,31 @@ const TreeEvents = [
|
|||
}
|
||||
];
|
||||
|
||||
const TreeSlots = [
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'searchicon',
|
||||
description: 'Custom search icon template.'
|
||||
},
|
||||
{
|
||||
name: 'togglericon',
|
||||
description: 'Custom toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'checkboxicon',
|
||||
description: 'Custom checkbox icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
tree: {
|
||||
name: 'Tree',
|
||||
description: 'Tree is used to display hierarchical data.',
|
||||
props: TreeProps,
|
||||
events: TreeEvents
|
||||
events: TreeEvents,
|
||||
slots: TreeSlots
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -43,13 +43,13 @@ const TreeSelectProps = [
|
|||
},
|
||||
{
|
||||
name: 'inputStyle',
|
||||
type: 'any',
|
||||
type: 'object',
|
||||
default: 'null',
|
||||
description: 'Inline style of the input field.'
|
||||
},
|
||||
{
|
||||
name: 'inputClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the input field.'
|
||||
},
|
||||
|
|
@ -61,7 +61,7 @@ const TreeSelectProps = [
|
|||
},
|
||||
{
|
||||
name: 'panelClass',
|
||||
type: 'string',
|
||||
type: 'string | object',
|
||||
default: 'null',
|
||||
description: 'Style class of the overlay panel.'
|
||||
},
|
||||
|
|
@ -101,6 +101,18 @@ const TreeSelectProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Used to define a string that labels the element.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -196,8 +208,16 @@ const TreeSelectSlots = [
|
|||
description: 'Custom content when there is no data to display'
|
||||
},
|
||||
{
|
||||
name: 'indicator',
|
||||
name: 'triggericon',
|
||||
description: 'Custom content for the dropdown indicator'
|
||||
},
|
||||
{
|
||||
name: 'itemtogglericon',
|
||||
description: 'Custom item toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'itemcheckboxicon',
|
||||
description: 'Custom item checkbox icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
|
|
@ -221,6 +221,24 @@ const TreeTableProps = [
|
|||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the responsive mode, currently only option is scroll.'
|
||||
},
|
||||
{
|
||||
name: 'size',
|
||||
type: 'string',
|
||||
default: 'null',
|
||||
description: 'Defines the size of the table.'
|
||||
},
|
||||
{
|
||||
name: 'pt',
|
||||
type: 'any',
|
||||
default: 'null',
|
||||
description: 'Used to pass attributes to DOM elements inside the component.'
|
||||
},
|
||||
{
|
||||
name: 'unstyled',
|
||||
type: 'boolean',
|
||||
default: 'false',
|
||||
description: 'When enabled, it removes component related styles in the core.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
@ -443,23 +461,55 @@ const TreeTableEvents = [
|
|||
const TreeTableSlots = [
|
||||
{
|
||||
name: 'header',
|
||||
description: "Custom content for the component's header"
|
||||
description: "Custom content for the component's header."
|
||||
},
|
||||
{
|
||||
name: 'paginatorstart',
|
||||
description: "Custom content for the component paginator's left side"
|
||||
description: "Custom content for the component paginator's left side."
|
||||
},
|
||||
{
|
||||
name: 'paginatorend',
|
||||
description: "Custom content for the component paginator's right side"
|
||||
description: "Custom content for the component paginator's right side."
|
||||
},
|
||||
{
|
||||
name: 'empty',
|
||||
description: 'Custom content when there is no data to display'
|
||||
description: 'Custom content when there is no data to display.'
|
||||
},
|
||||
{
|
||||
name: 'footer',
|
||||
description: "Custom content for the component's footer"
|
||||
description: "Custom content for the component's footer."
|
||||
},
|
||||
{
|
||||
name: 'loadingicon',
|
||||
description: 'Custom loading icon template.'
|
||||
},
|
||||
{
|
||||
name: 'togglericon',
|
||||
description: 'Custom toggler icon template.'
|
||||
},
|
||||
{
|
||||
name: 'checkboxicon',
|
||||
description: 'Custom checkbox icon template.'
|
||||
},
|
||||
{
|
||||
name: 'sorticon',
|
||||
description: 'Custom sort icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorfirstpagelinkicon',
|
||||
description: 'Custom paginator first page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorprevpagelinkicon',
|
||||
description: 'Custom paginator prev page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatornextpagelinkicon',
|
||||
description: 'Custom paginator next page link icon template.'
|
||||
},
|
||||
{
|
||||
name: 'paginatorlastpagelinkicon',
|
||||
description: 'Custom paginator last page link icon template.'
|
||||
}
|
||||
];
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue