diff --git a/.gitignore b/.gitignore index 6b1acf8ed..0f3b57e58 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ dist .vscode .idea .eslintcache +api-generator/typedoc.json diff --git a/api-generator/build-apidoc.js b/api-generator/build-apidoc.js index 46f8cefb0..b11bd771a 100644 --- a/api-generator/build-apidoc.js +++ b/api-generator/build-apidoc.js @@ -454,6 +454,53 @@ if (project) { }; }); + const module_enumerations_group = module.groups?.find((g) => g.title === 'Enumerations'); + + module_enumerations_group && + module_enumerations_group.children.forEach((event) => { + const event_props_description = event.comment && event.comment.summary.map((s) => s.text || '').join(' '); + + !doc[name]['enumerations'] && + (doc[name]['enumerations'] = { + description: staticMessages['enumerations'], + + values: {} + }); + + const members = []; + + if (event.groups) { + const event_members_group = event.groups.find((g) => g.title === 'Enumeration Members'); + + event_members_group && + event_members_group.children.forEach((prop) => { + members.push({ + name: prop.name, + optional: prop.flags.isOptional, + readonly: prop.flags.isReadonly, + value: prop.type.toString(), + description: + prop.comment && + prop.comment.summary + .map((s) => { + if (s.text.indexOf('[here]') > -1) { + return `${s.text.slice(0, s.text.indexOf('[here]'))} here ${s.text.slice(s.text.indexOf(')') + 1)}`; + } + + return s.text || ''; + }) + .join(' '), + deprecated: prop.comment && prop.comment.getTag('@deprecated') ? parseText(prop.comment.getTag('@deprecated').content[0]?.text) : undefined + }); + }); + } + + doc[name]['enumerations'].values[event.name] = { + description: event_props_description, + members + }; + }); + const module_types_group = module.groups?.find((g) => g.title === 'Type Aliases'); module_types_group && @@ -516,5 +563,5 @@ if (project) { !fs.existsSync(outputPath) && fs.mkdirSync(outputPath); fs.writeFileSync(path.resolve(outputPath, 'index.json'), typedocJSON); - /* app.generateJson(project, `./api-generator/typedoc.json`); */ + // app.generateJson(project, `./api-generator/typedoc.json`); } diff --git a/components/lib/accordion/style/AccordionStyle.d.ts b/components/lib/accordion/style/AccordionStyle.d.ts index ab0cac909..65ac38510 100644 --- a/components/lib/accordion/style/AccordionStyle.d.ts +++ b/components/lib/accordion/style/AccordionStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Accordion groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/accordion/) + * + * @module accordionstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum AccordionClasses { + root = 'p-accordion' +} + export interface AccordionStyle extends BaseStyle {} diff --git a/components/lib/accordioncontent/style/AccordionContentStyle.d.ts b/components/lib/accordioncontent/style/AccordionContentStyle.d.ts index 2c2b8f7e2..be706428f 100644 --- a/components/lib/accordioncontent/style/AccordionContentStyle.d.ts +++ b/components/lib/accordioncontent/style/AccordionContentStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * AccordionContent is a helper component for Accordion component. + * + * [Live Demo](https://www.primevue.org/accordion/) + * + * @module accordioncontentstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum AccordionContentClasses { + root = 'p-accordioncontent', + content = 'p-accordioncontent-content' +} + export interface AccordionContentStyle extends BaseStyle {} diff --git a/components/lib/accordionheader/style/AccordionHeaderStyle.d.ts b/components/lib/accordionheader/style/AccordionHeaderStyle.d.ts index 06a633eae..bf19c5acf 100644 --- a/components/lib/accordionheader/style/AccordionHeaderStyle.d.ts +++ b/components/lib/accordionheader/style/AccordionHeaderStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * AccordionHeader is a helper component for Accordion component. + * + * [Live Demo](https://www.primevue.org/accordion/) + * + * @module accordionheaderstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum AccordionHeaderClasses { + root = 'p-accordionheader', + toggleicon = 'p-accordionheader-toggle-icon' +} + export interface AccordionHeaderStyle extends BaseStyle {} diff --git a/components/lib/accordionpanel/style/AccordionPanelStyle.d.ts b/components/lib/accordionpanel/style/AccordionPanelStyle.d.ts index c7e655fa9..d156c9878 100644 --- a/components/lib/accordionpanel/style/AccordionPanelStyle.d.ts +++ b/components/lib/accordionpanel/style/AccordionPanelStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * AccordionPanel is a helper component for Accordion component. + * + * [Live Demo](https://www.primevue.org/accordion/) + * + * @module accordionpanelstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum AccordionPanelClasses { + root = 'p-accordionpanel' +} + export interface AccordionPanelStyle extends BaseStyle {} diff --git a/components/lib/accordiontab/style/AccordionTabStyle.d.ts b/components/lib/accordiontab/style/AccordionTabStyle.d.ts index 2c71fa27d..bbfd326ad 100644 --- a/components/lib/accordiontab/style/AccordionTabStyle.d.ts +++ b/components/lib/accordiontab/style/AccordionTabStyle.d.ts @@ -1,3 +1,15 @@ +/** + * @deprecated since v4. Use the new structure of Accordion instead. + * + * AccordionTab is a helper component for Accordion. + * + * [Live Demo](https://www.primevue.org/accordion/) + * + * @module accordiontabstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum AccordionTabClasses {} + export interface AccordionTabStyle extends BaseStyle {} diff --git a/components/lib/animateonscroll/style/AnimateOnScrollStyle.d.ts b/components/lib/animateonscroll/style/AnimateOnScrollStyle.d.ts index 975c432a7..9873e6867 100644 --- a/components/lib/animateonscroll/style/AnimateOnScrollStyle.d.ts +++ b/components/lib/animateonscroll/style/AnimateOnScrollStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * AnimateOnScroll manages PrimeFlex CSS classes declaratively to during enter/leave animations on scroll or on page load. + * + * [Live Demo](https://primevue.org/animateonscroll) + * + * @module animateonscrollstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum AnimateOnScrollClasses {} + export interface AnimateOnScrollStyle extends BaseStyle {} diff --git a/components/lib/autocomplete/style/AutoCompleteStyle.d.ts b/components/lib/autocomplete/style/AutoCompleteStyle.d.ts index 27011126a..bea7844cd 100644 --- a/components/lib/autocomplete/style/AutoCompleteStyle.d.ts +++ b/components/lib/autocomplete/style/AutoCompleteStyle.d.ts @@ -1,3 +1,29 @@ +/** + * + * AutoComplete is an input component that provides real-time suggestions while being typed. + * + * [Live Demo](https://www.primevue.org/autocomplete/) + * + * @module autocompletestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum AutoCompleteClasses { + root = 'p-autocomplete', + pcInput = 'p-autocomplete-input', + inputMultiple = 'p-autocomplete-input-multiple', + chip = 'p-autocomplete-chip', + pcChipLabel = 'p-autocomplete-chip-label', + chipIcon = 'p-autocomplete-chip-icon', + inputChip = 'p-autocomplete-input-chip', + loader = 'p-autocomplete-loader', + dropdown = 'p-autocomplete-dropdown', + panel = 'p-autocomplete-overlay', + list = 'p-autocomplete-list', + optionGroup = 'p-autocomplete-option-group', + option = 'p-autocomplete-option', + emptyMessage = 'p-autocomplete-empty-message' +} + export interface AutoCompleteStyle extends BaseStyle {} diff --git a/components/lib/avatar/style/AvatarStyle.d.ts b/components/lib/avatar/style/AvatarStyle.d.ts index fcb6ff6ed..617a65db7 100644 --- a/components/lib/avatar/style/AvatarStyle.d.ts +++ b/components/lib/avatar/style/AvatarStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Avatar represents people using icons, labels and images. + * + * - [Live Demo](https://primevue.org/avatar) + * + * @module avatarstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum AvatarClasses { + root = 'p-avatar', + label = 'p-avatar-label', + icon = 'p-avatar-icon' +} + export interface AvatarStyle extends BaseStyle {} diff --git a/components/lib/avatargroup/style/AvatarGroupStyle.d.ts b/components/lib/avatargroup/style/AvatarGroupStyle.d.ts index 9e2d75c0b..8cce39436 100644 --- a/components/lib/avatargroup/style/AvatarGroupStyle.d.ts +++ b/components/lib/avatargroup/style/AvatarGroupStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * A set of Avatars can be displayed together using the AvatarGroup component. + * + * [Live Demo](https://www.primevue.org/avatar/) + * + * @module avatargroupstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum AvatarGroupClasses { + root = 'p-avatar-group' +} + export interface AvatarGroupStyle extends BaseStyle {} diff --git a/components/lib/badge/style/BadgeStyle.d.ts b/components/lib/badge/style/BadgeStyle.d.ts index 2d205d233..4a0fe6809 100644 --- a/components/lib/badge/style/BadgeStyle.d.ts +++ b/components/lib/badge/style/BadgeStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Badge represents people using icons, labels and images. + * + * [Live Demo](https://www.primevue.org/badge) + * + * @module badgestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BadgeClasses { + root = 'p-badge' +} + export interface BadgeStyle extends BaseStyle {} diff --git a/components/lib/badgedirective/style/BadgeDirectiveStyle.d.ts b/components/lib/badgedirective/style/BadgeDirectiveStyle.d.ts index 40299717d..0dd0e3383 100644 --- a/components/lib/badgedirective/style/BadgeDirectiveStyle.d.ts +++ b/components/lib/badgedirective/style/BadgeDirectiveStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Badge directive is a small status indicator for another element. + * + * [Live Demo](https://primevue.org/badge) + * + * @module badgedirectivestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BadgeDirectiveClasses { + root = 'p-badge' +} + export interface BadgeDirectiveStyle extends BaseStyle {} diff --git a/components/lib/base/style/BaseStyle.d.ts b/components/lib/base/style/BaseStyle.d.ts index d39b243a0..626dc1a52 100644 --- a/components/lib/base/style/BaseStyle.d.ts +++ b/components/lib/base/style/BaseStyle.d.ts @@ -1,5 +1,14 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module basestyle + * + */ import { Style, StyleOptions } from '../../usestyle'; +export enum BaseClasses {} + export declare interface BaseStyle { name?: string | undefined; css?: string | undefined; diff --git a/components/lib/basecomponent/BaseComponent.d.ts b/components/lib/basecomponent/BaseComponent.d.ts index 382be7f24..2a42d0d4b 100644 --- a/components/lib/basecomponent/BaseComponent.d.ts +++ b/components/lib/basecomponent/BaseComponent.d.ts @@ -1,3 +1,10 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module basecomponent + * + */ export interface ComponentHooks { onBeforeCreate?(): void; onCreated?(): void; diff --git a/components/lib/basecomponent/style/BaseComponentStyle.d.ts b/components/lib/basecomponent/style/BaseComponentStyle.d.ts index 6f74930b9..ca3d62090 100644 --- a/components/lib/basecomponent/style/BaseComponentStyle.d.ts +++ b/components/lib/basecomponent/style/BaseComponentStyle.d.ts @@ -1,3 +1,12 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module basecomponentstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BaseComponentClasses {} + export interface BaseComponentStyle extends BaseStyle {} diff --git a/components/lib/basedirective/BaseDirective.d.ts b/components/lib/basedirective/BaseDirective.d.ts index 7748053ce..572cbbe86 100644 --- a/components/lib/basedirective/BaseDirective.d.ts +++ b/components/lib/basedirective/BaseDirective.d.ts @@ -1,3 +1,10 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module basedirective + * + */ import { DirectiveBinding, VNode } from 'vue'; export interface DirectiveInstance { diff --git a/components/lib/baseicon/style/BaseIconStyle.d.ts b/components/lib/baseicon/style/BaseIconStyle.d.ts index 5cb4c2e9c..df342c975 100644 --- a/components/lib/baseicon/style/BaseIconStyle.d.ts +++ b/components/lib/baseicon/style/BaseIconStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module baseiconstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BaseIconClasses { + root = 'p-icon' +} + export interface BaseIconStyle extends BaseStyle {} diff --git a/components/lib/blockui/style/BlockUIStyle.d.ts b/components/lib/blockui/style/BlockUIStyle.d.ts index 2d6a5e9fc..a4cb041fb 100644 --- a/components/lib/blockui/style/BlockUIStyle.d.ts +++ b/components/lib/blockui/style/BlockUIStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * BlockUI represents people using icons, labels and images. + * + * [Live Demo](https://www.primevue.org/blockui) + * + * @module blockuistyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BlockUIClasses { + root = 'p-blockui' +} + export interface BlockUIStyle extends BaseStyle {} diff --git a/components/lib/breadcrumb/style/BreadcrumbStyle.d.ts b/components/lib/breadcrumb/style/BreadcrumbStyle.d.ts index 1cafdf43b..de6fecec2 100644 --- a/components/lib/breadcrumb/style/BreadcrumbStyle.d.ts +++ b/components/lib/breadcrumb/style/BreadcrumbStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * Breadcrumb provides contextual information about page hierarchy. + * + * [Live Demo](https://www.primevue.org/breadcrumb/) + * + * @module breadcrumbstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum BreadcrumbClasses { + root = 'p-breadcrumb', + list = 'p-breadcrumb-list', + homeItem = 'p-breadcrumb-home-item', + separator = 'p-breadcrumb-separator', + item = 'p-breadcrumb-item', + itemLink = 'p-breadcrumb-item-link', + itemIcon = 'p-breadcrumb-item-icon', + itemLabel = 'p-breadcrumb-item-label' +} + export interface BreadcrumbStyle extends BaseStyle {} diff --git a/components/lib/button/style/ButtonStyle.d.ts b/components/lib/button/style/ButtonStyle.d.ts index fcffcf8e9..df6267db0 100644 --- a/components/lib/button/style/ButtonStyle.d.ts +++ b/components/lib/button/style/ButtonStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * Button is an extension to standard button element with icons and theming. + * + * [Live Demo](https://www.primevue.org/button/) + * + * @module buttonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ButtonClasses { + root = 'p-button', + loadingIcon = 'p-button-loading-icon', + icon = 'p-button-icon', + label = 'p-button-label' +} + export interface ButtonStyle extends BaseStyle {} diff --git a/components/lib/buttongroup/style/ButtonGroupStyle.d.ts b/components/lib/buttongroup/style/ButtonGroupStyle.d.ts index 9a364f348..b3d8ef335 100644 --- a/components/lib/buttongroup/style/ButtonGroupStyle.d.ts +++ b/components/lib/buttongroup/style/ButtonGroupStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * A set of Buttons can be displayed together using the ButtonGroup component. + * + * [Live Demo](https://www.primevue.org/button/) + * + * @module buttongroupstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum ButtonGroupClasses { + root = 'p-buttongroup' +} + export interface ButtonGroupStyle extends BaseStyle {} diff --git a/components/lib/calendar/style/CalendarStyle.d.ts b/components/lib/calendar/style/CalendarStyle.d.ts index 303868a76..768071f1e 100644 --- a/components/lib/calendar/style/CalendarStyle.d.ts +++ b/components/lib/calendar/style/CalendarStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Calendar also known as DatePicker, is a form component to work with dates. + * + * [Live Demo](https://www.primevue.org/datepicker/) + * + * @module calendarstyle + * + */ import { DatePickerStyle } from '../../datepicker/style/DatePickerStyle'; +export enum CalendarClasses {} + export interface CalendarStyle extends DatePickerStyle {} diff --git a/components/lib/card/style/CardStyle.d.ts b/components/lib/card/style/CardStyle.d.ts index a9904f30b..bfcb746cb 100644 --- a/components/lib/card/style/CardStyle.d.ts +++ b/components/lib/card/style/CardStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * Card is a flexible container component. + * + * [Live Demo](https://www.primevue.org/card/) + * + * @module cardstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum CardClasses { + root = 'p-card', + header = 'p-card-header', + body = 'p-card-body', + caption = 'p-card-caption', + title = 'p-card-title', + subtitle = 'p-card-subtitle', + content = 'p-card-content', + footer = 'p-card-footer' +} + export interface CardStyle extends BaseStyle {} diff --git a/components/lib/carousel/style/CarouselStyle.d.ts b/components/lib/carousel/style/CarouselStyle.d.ts index 8f83947ce..285707bad 100644 --- a/components/lib/carousel/style/CarouselStyle.d.ts +++ b/components/lib/carousel/style/CarouselStyle.d.ts @@ -1,3 +1,29 @@ +/** + * + * Carousel is a content slider featuring various customization options. + * + * [Live Demo](https://www.primevue.org/carousel/) + * + * @module carouselstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum CarouselClasses { + root = 'p-carousel', + header = 'p-carousel-header', + contentContainer = 'p-carousel-content-container', + content = 'p-carousel-content', + pcPreviousButton = 'p-carousel-prev-button', + viewport = 'p-carousel-viewport', + itemList = 'p-carousel-item-list', + itemClone = 'p-carousel-item-clone', + item = 'p-carousel-item', + pcNextButton = 'p-carousel-next-button', + indicatorList = 'p-carousel-indicator-list', + indicator = 'p-carousel-indicator', + indicatorButton = 'p-carousel-indicator-button', + footer = 'p-carousel-footer' +} + export interface CarouselStyle extends BaseStyle {} diff --git a/components/lib/cascadeselect/style/CascadeSelectStyle.d.ts b/components/lib/cascadeselect/style/CascadeSelectStyle.d.ts index 2bad11aaf..3d96ff93e 100644 --- a/components/lib/cascadeselect/style/CascadeSelectStyle.d.ts +++ b/components/lib/cascadeselect/style/CascadeSelectStyle.d.ts @@ -1,3 +1,28 @@ +/** + * + * CascadeSelect is a form component to select a value from a nested structure of options. + * + * [Live Demo](https://www.primevue.org/cascadeselect/) + * + * @module cascadeselectstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum CascadeSelectClasses { + root = 'p-cascadeselect', + label = 'p-cascadeselect-label', + dropdown = 'p-cascadeselect-dropdown', + loadingIcon = 'p-cascadeselect-loading-icon', + dropdownIcon = 'p-cascadeselect-dropdown-icon', + overlay = 'p-cascadeselect-overlay', + listContainer = 'p-cascadeselect-list-container', + list = 'p-cascadeselect-list', + item = 'p-cascadeselect-item', + itemContent = 'p-cascadeselect-item-content', + itemText = 'p-cascadeselect-item-text', + groupIcon = 'p-cascadeselect-group-icon', + itemList = 'p-cascadeselect-item-list' +} + export interface CascadeSelectStyle extends BaseStyle {} diff --git a/components/lib/chart/style/ChartStyle.d.ts b/components/lib/chart/style/ChartStyle.d.ts index c0a19dfb1..97cca1ea4 100644 --- a/components/lib/chart/style/ChartStyle.d.ts +++ b/components/lib/chart/style/ChartStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Chart groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/chart/) + * + * @module chartstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ChartClasses { + root = 'p-chart' +} + export interface ChartStyle extends BaseStyle {} diff --git a/components/lib/checkbox/style/CheckboxStyle.d.ts b/components/lib/checkbox/style/CheckboxStyle.d.ts index 6d5aa15e8..1a8119a62 100644 --- a/components/lib/checkbox/style/CheckboxStyle.d.ts +++ b/components/lib/checkbox/style/CheckboxStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * Checkbox is an extension to standard checkbox element with theming. + * + * [Live Demo](https://www.primevue.org/checkbox/) + * + * @module checkboxstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum CheckboxClasses { + root = 'p-checkbox', + box = 'p-checkbox-box', + input = 'p-checkbox-input', + icon = 'p-checkbox-icon' +} + export interface CheckboxStyle extends BaseStyle {} diff --git a/components/lib/chip/style/ChipStyle.d.ts b/components/lib/chip/style/ChipStyle.d.ts index 6cda03aa4..9ada2f562 100644 --- a/components/lib/chip/style/ChipStyle.d.ts +++ b/components/lib/chip/style/ChipStyle.d.ts @@ -1,3 +1,20 @@ +/** + * + * Chip represents people using icons, labels and images. + * + * [Live Demo](https://www.primevue.org/chip) + * + * @module chipstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ChipClasses { + root = 'p-chip', + image = 'p-chip-image', + icon = 'p-chip-icon', + label = 'p-chip-label', + removeIcon = 'p-chip-remove-icon' +} + export interface ChipStyle extends BaseStyle {} diff --git a/components/lib/chips/style/ChipsStyle.d.ts b/components/lib/chips/style/ChipsStyle.d.ts index 094576a62..7afcdbfe4 100644 --- a/components/lib/chips/style/ChipsStyle.d.ts +++ b/components/lib/chips/style/ChipsStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Chips groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/inputchips/) + * + * @module chipsstyle + * + */ import { InputChipsStyle } from '../../inputchips/style/InputChipsStyle'; +export enum ChipsClasses {} + export interface ChipsStyle extends InputChipsStyle {} diff --git a/components/lib/colorpicker/style/ColorPickerStyle.d.ts b/components/lib/colorpicker/style/ColorPickerStyle.d.ts index 7c5702018..1a2780ddd 100644 --- a/components/lib/colorpicker/style/ColorPickerStyle.d.ts +++ b/components/lib/colorpicker/style/ColorPickerStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * ColorPicker groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/colorpicker/) + * + * @module colorpickerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ColorPickerClasses { + root = 'p-colorpicker', + preview = 'p-colorpicker-preview', + panel = 'p-colorpicker-panel', + colorSelector = 'p-colorpicker-color-selector', + colorBackground = 'p-colorpicker-color-background', + colorHandle = 'p-colorpicker-color-handle', + hue = 'p-colorpicker-hue', + hueHandle = 'p-colorpicker-hue-handle' +} + export interface ColorPickerStyle extends BaseStyle {} diff --git a/components/lib/column/Column.d.ts b/components/lib/column/Column.d.ts index 17ceec71b..24191eb6d 100755 --- a/components/lib/column/Column.d.ts +++ b/components/lib/column/Column.d.ts @@ -8,7 +8,6 @@ * @module column * */ - import { VNode } from 'vue'; import { ComponentHooks } from '../basecomponent'; import { ButtonPassThroughOptions } from '../button'; diff --git a/components/lib/column/style/ColumnStyle.d.ts b/components/lib/column/style/ColumnStyle.d.ts index a5cd93706..dff39ea5c 100644 --- a/components/lib/column/style/ColumnStyle.d.ts +++ b/components/lib/column/style/ColumnStyle.d.ts @@ -1,3 +1,15 @@ +/** + * + * Column component defines various options to specify corresponding features. + * It is a helper component for DataTable and TreeTable. + * + * [Live Demo](https://www.primevue.org/datatable/) + * + * @module columnstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ColumnClasses {} + export interface ColumnStyle extends BaseStyle {} diff --git a/components/lib/columngroup/ColumnGroup.d.ts b/components/lib/columngroup/ColumnGroup.d.ts index 70912af5a..fb0ba1a9b 100755 --- a/components/lib/columngroup/ColumnGroup.d.ts +++ b/components/lib/columngroup/ColumnGroup.d.ts @@ -1,9 +1,11 @@ /** + * * Columns can be grouped at header and footer sections by defining a ColumnGroup component. * It is a helper component for DataTable. * * [Live Demo](https://www.primevue.org/datatable/) * @module columngroup + * */ import { ComponentHooks } from '../basecomponent'; import { PassThroughOptions } from '../passthrough'; diff --git a/components/lib/columngroup/style/ColumnGroupStyle.d.ts b/components/lib/columngroup/style/ColumnGroupStyle.d.ts index 1e5672f0a..075331304 100644 --- a/components/lib/columngroup/style/ColumnGroupStyle.d.ts +++ b/components/lib/columngroup/style/ColumnGroupStyle.d.ts @@ -1,3 +1,15 @@ +/** + * + * Columns can be grouped at header and footer sections by defining a ColumnGroup component. + * It is a helper component for DataTable. + * + * [Live Demo](https://www.primevue.org/datatable/) + * + * @module columngroupstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ColumnGroupClasses {} + export interface ColumnGroupStyle extends BaseStyle {} diff --git a/components/lib/confirmdialog/style/ConfirmDialogStyle.d.ts b/components/lib/confirmdialog/style/ConfirmDialogStyle.d.ts index 39cd0111e..f4d7e1089 100644 --- a/components/lib/confirmdialog/style/ConfirmDialogStyle.d.ts +++ b/components/lib/confirmdialog/style/ConfirmDialogStyle.d.ts @@ -1,3 +1,20 @@ +/** + * + * ConfirmDialog uses a Dialog UI with confirmDialog method or tag. + * + * [Live Demo](https://www.primevue.org/confirmdialog) + * + * @module confirmdialogstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ConfirmDialogClasses { + root = 'p-confirmdialog', + icon = 'p-confirmdialog-icon', + message = 'p-confirmdialog-message', + pcRejectButton = 'p-confirmdialog-reject-button', + pcAcceptButton = 'p-confirmdialog-accept-button' +} + export interface ConfirmDialogStyle extends BaseStyle {} diff --git a/components/lib/confirmpopup/style/ConfirmPopupStyle.d.ts b/components/lib/confirmpopup/style/ConfirmPopupStyle.d.ts index 214b9a459..cb1cd82e7 100644 --- a/components/lib/confirmpopup/style/ConfirmPopupStyle.d.ts +++ b/components/lib/confirmpopup/style/ConfirmPopupStyle.d.ts @@ -1,3 +1,22 @@ +/** + * + * ConfirmPopup displays a confirmation overlay displayed relatively to its target. + * + * [Live Demo](https://www.primevue.org/confirmpopup) + * + * @module confirmpopupstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ConfirmPopupClasses { + root = 'p-confirmpopup', + content = 'p-confirmpopup-content', + icon = 'p-confirmpopup-icon', + message = 'p-confirmpopup-message', + footer = 'p-confirmpopup-footer', + pcRejectButton = 'p-confirmpopup-reject-button', + pcAcceptButton = 'p-confirmpopup-accept-button' +} + export interface ConfirmPopupStyle extends BaseStyle {} diff --git a/components/lib/contextmenu/style/ContextMenuStyle.d.ts b/components/lib/contextmenu/style/ContextMenuStyle.d.ts index 8e3a5b6e6..9375c9e9e 100644 --- a/components/lib/contextmenu/style/ContextMenuStyle.d.ts +++ b/components/lib/contextmenu/style/ContextMenuStyle.d.ts @@ -1,3 +1,26 @@ +/** + * + * ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu. + * Refer to documentation of the individual documentation of the with context menu support. + * + * [Live Demo](https://www.primevue.org/contextmenu/) + * + * @module contextmenustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ContextMenuClasses { + root = 'p-contextmenu', + rootList = 'p-contextmenu-root-list', + item = 'p-contextmenu-item', + itemContent = 'p-contextmenu-item-content', + itemLink = 'p-contextmenu-item-link', + itemIcon = 'p-contextmenu-item-icon', + itemLabel = 'p-contextmenu-item-label', + submenuIcon = 'p-contextmenu-submenu-icon', + submenu = 'p-contextmenu-submenu', + separator = 'p-contextmenu-separator' +} + export interface ContextMenuStyle extends BaseStyle {} diff --git a/components/lib/datatable/style/DataTableStyle.d.ts b/components/lib/datatable/style/DataTableStyle.d.ts index 02622b718..bbb05518b 100644 --- a/components/lib/datatable/style/DataTableStyle.d.ts +++ b/components/lib/datatable/style/DataTableStyle.d.ts @@ -1,3 +1,63 @@ +/** + * + * DataTable displays data in tabular format. + * + * [Live Demo](https://www.primevue.org/datatable/) + * + * @module datatablestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DataTableClasses { + root = 'p-datatable', + mask = 'p-datatable-mask', + loadingIcon = 'p-datatable-loading-icon', + header = 'p-datatable-header', + pcPaginator = 'p-datatable-paginator-[position]', + tableContainer = 'p-datatable-table-container', + table = 'p-datatable-table', + thead = 'p-datatable-thead', + columnResizer = 'p-datatable-column-resizer', + columnHeaderContent = 'p-datatable-column-header-content', + columnTitle = 'p-datatable-column-title', + sortIcon = 'p-datatable-sort-icon', + sortBadge = 'p-datatable-sort-badge', + filter = 'p-datatable-filter', + filterElementContainer = 'p-datatable-filter-element-container', + pcColumnFilterButton = 'p-datatable-column-filter-button', + pcColumnFilterClearButton = 'p-datatable-column-filter-clear-button', + filterOverlay = 'p-datatable-filter-overlay', + filterConstraintList = 'p-datatable-filter-constraint-list', + filterConstraint = 'p-datatable-filter-constraint', + filterConstraintSeparator = 'p-datatable-filter-constraint-separator', + filterOperator = 'p-datatable-filter-operator', + pcFilterOperatorDropdown = 'p-datatable-filter-operator-dropdown', + filterRuleList = 'p-datatable-filter-rule-list', + filterRule = 'p-datatable-filter-rule', + pcFilterConstraintDropdown = 'p-datatable-filter-constraint-dropdown', + pcFilterRemoveRuleButton = 'p-datatable-filter-remove-rule-button', + pcFilterAddButton = 'p-column-filter-add-button', + filterButtonbar = 'p-datatable-filter-buttonbar', + pcFilterClearButton = 'p-datatable-filter-clear-button', + pcFilterApplyButton = 'p-datatable-filter-apply-button', + tbody = 'p-datatable-tbody', + rowGroupHeader = 'p-datatable-row-group-header', + rowToggleButton = 'p-datatable-row-toggle-button', + rowToggleIcon = 'p-datatable-row-toggle-icon', + rowExpansion = 'p-datatable-row-expansion', + rowGroupFooter = 'p-datatable-row-group-footer', + emptyMessage = 'p-datatable-empty-message', + reorderableRowHandle = 'p-datatable-reorderable-row-handle', + pcRowEditorInit = 'p-datatable-row-editor-init', + pcRowEditorSave = 'p-datatable-row-editor-save', + pcRowEditorCancel = 'p-datatable-row-editor-cancel', + tfoot = 'p-datatable-tfoot', + virtualScrollerSpacer = 'p-datatable-virtualscroller-spacer', + footer = 'p-datatable-footer', + columnResizeIndicator = 'p-datatable-column-resize-indicator', + rowReorderIndicatorUp = 'p-datatable-row-reorder-indicator-up', + rowReorderIndicatorDown = 'p-datatable-row-reorder-indicator-down' +} + export interface DataTableStyle extends BaseStyle {} diff --git a/components/lib/dataview/style/DataViewStyle.d.ts b/components/lib/dataview/style/DataViewStyle.d.ts index 900ecf26e..7b18a522c 100644 --- a/components/lib/dataview/style/DataViewStyle.d.ts +++ b/components/lib/dataview/style/DataViewStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * DataView displays data in grid or list layout with pagination and sorting features. + * + * [Live Demo](https://www.primevue.org/dataview/) + * + * @module dataviewstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DataViewClasses { + root = 'p-dataview', + header = 'p-dataview-header', + pcPaginator = 'p-dataview-paginator-[position]', + content = 'p-dataview-content', + emptyMessage = 'p-dataview-empty-message', // TODO: remove? + footer = 'p-dataview-footer' +} + export interface DataViewStyle extends BaseStyle {} diff --git a/components/lib/datepicker/style/DatePickerStyle.d.ts b/components/lib/datepicker/style/DatePickerStyle.d.ts index 94bd7f56d..8986577a2 100644 --- a/components/lib/datepicker/style/DatePickerStyle.d.ts +++ b/components/lib/datepicker/style/DatePickerStyle.d.ts @@ -1,3 +1,53 @@ +/** + * + * DatePicker is a form component to work with dates. + * + * [Live Demo](https://www.primevue.org/datepicker/) + * + * @module datepickerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DatePickerClasses { + root = 'p-datepicker', + pcInput = 'p-datepicker-input', + dropdown = 'p-datepicker-dropdown', + inputIconContainer = 'p-datepicker-input-icon-container', + inputIcon = 'p-datepicker-input-icon', + panel = 'p-datepicker-panel', + calendarContainer = 'p-datepicker-calendar-container', + calendar = 'p-datepicker-calendar', + header = 'p-datepicker-header', + pcPreviousButton = 'p-datepicker-prev-button', + title = 'p-datepicker-title', + viewMonth = 'p-datepicker-view-month', + viewYear = 'p-datepicker-view-year', + decade = 'p-datepicker-decade', + pcNextButton = 'p-datepicker-next-button', + dayView = 'p-datepicker-day-view', + weekHeader = 'p-datepicker-weekheader', + weekNumber = 'p-datepicker-weeknumber', + weekLabelContainer = 'p-disabled', + weekDayCell = 'p-datepicker-weekday-cell', + weekDay = 'p-date-picker-weekday', + dayCell = 'p-datepicker-day-cell', + day = 'p-datepicker-day', + monthView = 'p-datepicker-month-view', + month = 'p-datepicker-month', + yearView = 'p-datepicker-year-view', + year = 'p-datepicker-year', + timePicker = 'p-datepicker-time-picker', + hourPicker = 'p-datepicker-hour-picker', + pcIncrementButton = 'p-datepicker-increment-button', + pcDecrementButton = 'p-datepicker-decrement-button', + separator = 'p-datepicker-separator', + minutePicker = 'p-datepicker-minute-picker', + secondPicker = 'p-datepicker-second-picker', + ampmPicker = 'p-datepicker-ampm-picker', + buttonbar = 'p-datepicker-buttonbar', + pcTodayButton = 'p-datepicker-today-button', + pcClearButton = 'p-datepicker-clear-button' +} + export interface DatePickerStyle extends BaseStyle {} diff --git a/components/lib/deferredcontent/style/DeferredContentStyle.d.ts b/components/lib/deferredcontent/style/DeferredContentStyle.d.ts index 5a7defecc..e46e0a31f 100644 --- a/components/lib/deferredcontent/style/DeferredContentStyle.d.ts +++ b/components/lib/deferredcontent/style/DeferredContentStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * DeferredContent postpones the loading the content that is initially not in the viewport until it becomes visible on scroll. + * + * [Live Demo](https://www.primevue.org/deferredcontent/) + * + * @module deferredcontentstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DeferredContentClasses {} + export interface DeferredContentStyle extends BaseStyle {} diff --git a/components/lib/dialog/style/DialogStyle.d.ts b/components/lib/dialog/style/DialogStyle.d.ts index 95caf5cd9..6955d4039 100644 --- a/components/lib/dialog/style/DialogStyle.d.ts +++ b/components/lib/dialog/style/DialogStyle.d.ts @@ -1,3 +1,24 @@ +/** + * + * Dialog is a container to display content in an overlay window. + * + * [Live Demo](https://www.primevue.org/dialog) + * + * @module dialogstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DialogClasses { + mask = 'p-dialog-mask', + root = 'p-dialog', + header = 'p-dialog-header', + title = 'p-dialog-title', + headerActions = 'p-dialog-header-actions', + pcMaximizeButton = 'p-dialog-maximize-button', + pcCloseButton = 'p-dialog-close-button', + content = 'p-dialog-content', + footer = 'p-dialog-footer' +} + export interface DialogStyle extends BaseStyle {} diff --git a/components/lib/dialogservice/DialogService.d.ts b/components/lib/dialogservice/DialogService.d.ts index 43e2336a5..575a390b7 100644 --- a/components/lib/dialogservice/DialogService.d.ts +++ b/components/lib/dialogservice/DialogService.d.ts @@ -1,6 +1,7 @@ /** * * [Live Demo](https://www.primevue.org/dynamicdialog/) + * * @module dialogservice-usedialog */ import { Plugin } from 'vue'; diff --git a/components/lib/divider/style/DividerStyle.d.ts b/components/lib/divider/style/DividerStyle.d.ts index afb4979ca..450a6527a 100644 --- a/components/lib/divider/style/DividerStyle.d.ts +++ b/components/lib/divider/style/DividerStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * Divider is used to separate contents. + * + * [Live Demo](https://primevue.org/divider) + * + * @module dividerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DividerClasses { + root = 'p-divider', + content = 'p-divider-content' +} + export interface DividerStyle extends BaseStyle {} diff --git a/components/lib/dock/style/DockStyle.d.ts b/components/lib/dock/style/DockStyle.d.ts index 93be7672e..16b32acc5 100644 --- a/components/lib/dock/style/DockStyle.d.ts +++ b/components/lib/dock/style/DockStyle.d.ts @@ -1,3 +1,22 @@ +/** + * + * Dock is a navigation component consisting of menuitems. + * + * [Live Demo](https://www.primevue.org/dock/) + * + * @module dockstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DockClasses { + root = 'p-dock', + listContainer = 'p-dock-list-container', + list = 'p-dock-list', + item = 'p-dock-item', + itemContent = 'p-dock-item-content', + itemLink = 'p-dock-item-link', + itemIcon = 'p-dock-item-icon' +} + export interface DockStyle extends BaseStyle {} diff --git a/components/lib/drawer/style/DrawerStyle.d.ts b/components/lib/drawer/style/DrawerStyle.d.ts index 90c0e7732..757fcd29a 100644 --- a/components/lib/drawer/style/DrawerStyle.d.ts +++ b/components/lib/drawer/style/DrawerStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * Drawer is a panel component displayed as an overlay at the edges of the screen. + * + * [Live Demo](https://primevue.org/drawer) + * + * @module drawerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DrawerClasses { + mask = 'p-drawer-mask', + root = 'p-drawer', + header = 'p-drawer-header', + title = 'p-drawer-title', + pcCloseButton = 'p-drawer-close-button', + content = 'p-drawer-content' +} + export interface DrawerStyle extends BaseStyle {} diff --git a/components/lib/dropdown/style/DropdownStyle.d.ts b/components/lib/dropdown/style/DropdownStyle.d.ts index b6b31a960..add903b40 100644 --- a/components/lib/dropdown/style/DropdownStyle.d.ts +++ b/components/lib/dropdown/style/DropdownStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Dropdown also known as Select, is used to choose an item from a collection of options. + * + * [Live Demo](https://www.primevue.org/select/) + * + * @module dropdownstyle + * + */ import { SelectStyle } from '../../select/style/SelectStyle'; +export enum DropdownClasses {} + export interface DropdownStyle extends SelectStyle {} diff --git a/components/lib/dynamicdialog/style/DynamicDialogStyle.d.ts b/components/lib/dynamicdialog/style/DynamicDialogStyle.d.ts index e2be276d4..a0de72ed2 100644 --- a/components/lib/dynamicdialog/style/DynamicDialogStyle.d.ts +++ b/components/lib/dynamicdialog/style/DynamicDialogStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * DynamicDialogs can be created dynamically with any component as the content using a DialogService. + * + * [Live Demo](https://primevue.org/dynamicdialog) + * + * @module dynamicdialogstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum DynamicDialogClasses {} + export interface DynamicDialogStyle extends BaseStyle {} diff --git a/components/lib/editor/style/EditorStyle.d.ts b/components/lib/editor/style/EditorStyle.d.ts index 6408c7103..258762106 100644 --- a/components/lib/editor/style/EditorStyle.d.ts +++ b/components/lib/editor/style/EditorStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Editor groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/editor/) + * + * @module editorstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum EditorClasses { + root = 'p-editor', + toolbar = 'p-editor-toolbar', + content = 'p-editor-content' +} + export interface EditorStyle extends BaseStyle {} diff --git a/components/lib/fieldset/style/FieldsetStyle.d.ts b/components/lib/fieldset/style/FieldsetStyle.d.ts index 5f4ffca1d..63e2152d2 100644 --- a/components/lib/fieldset/style/FieldsetStyle.d.ts +++ b/components/lib/fieldset/style/FieldsetStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * Fieldset is a grouping component with the optional content toggle feature. + * + * [Live Demo](https://www.primevue.org/fieldset/) + * + * @module fieldsetstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum FieldsetClasses { + root = 'p-fieldset', + legend = 'p-fieldset-legend', + legendLabel = 'p-fieldset-legend-label', + toggleIcon = 'p-fieldset-toggle-icon', + contentContainer = 'p-fieldset-content-container', + content = 'p-fieldset-content' +} + export interface FieldsetStyle extends BaseStyle {} diff --git a/components/lib/fileupload/style/FileUploadStyle.d.ts b/components/lib/fileupload/style/FileUploadStyle.d.ts index d83d7298e..21f41e06a 100644 --- a/components/lib/fileupload/style/FileUploadStyle.d.ts +++ b/components/lib/fileupload/style/FileUploadStyle.d.ts @@ -1,3 +1,30 @@ +/** + * + * FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations. + * + * [Live Demo](https://www.primevue.org/fileupload/) + * + * @module fileuploadstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum FileUploadClasses { + root = 'p-fileupload', + header = 'p-fileupload-header', + pcChooseButton = 'p-fileupload-choose-button', + pcUploadButton = 'p-fileupload-upload-button', + pcCancelButton = 'p-fileupload-cancel-button', + content = 'p-fileupload-content', + fileList = 'p-fileupload-file-list', + file = 'p-fileupload-file', + fileThumbnail = 'p-fileupload-file-thumbnail', + fileInfo = 'p-fileupload-file-info', + fileName = 'p-fileupload-file-name', + fileSize = 'p-fileupload-file-size', + pcFileBadge = 'p-fileupload-file-badge', + fileActions = 'p-fileupload-file-actions', + pcFileRemoveButton = 'p-fileupload-file-remove-button' +} + export interface FileUploadStyle extends BaseStyle {} diff --git a/components/lib/floatlabel/style/FloatLabelStyle.d.ts b/components/lib/floatlabel/style/FloatLabelStyle.d.ts index e0f1ce3ea..9d19dbd50 100644 --- a/components/lib/floatlabel/style/FloatLabelStyle.d.ts +++ b/components/lib/floatlabel/style/FloatLabelStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * FloatLabel appears on top of the input field when focused. + * + * [Live Demo](https://www.primevue.org/inputtext/) + * + * @module floatlabelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum FloatLabelClasses { + root = 'p-float-label' +} + export interface FloatLabelStyle extends BaseStyle {} diff --git a/components/lib/focustrap/FocusTrap.d.ts b/components/lib/focustrap/FocusTrap.d.ts index f6e295e53..a201b8ff5 100644 --- a/components/lib/focustrap/FocusTrap.d.ts +++ b/components/lib/focustrap/FocusTrap.d.ts @@ -5,6 +5,7 @@ * [Live Demo](https://primevue.org/focustrap) * * @module focustrap + * */ import { DirectiveBinding, ObjectDirective } from 'vue'; import { DirectiveHooks } from '../basedirective'; diff --git a/components/lib/focustrap/style/FocusTrapStyle.d.ts b/components/lib/focustrap/style/FocusTrapStyle.d.ts index 07e92d020..43ca0489f 100644 --- a/components/lib/focustrap/style/FocusTrapStyle.d.ts +++ b/components/lib/focustrap/style/FocusTrapStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Focus Trap keeps focus within a certain DOM element while tabbing. + * + * [Live Demo](https://primevue.org/focustrap) + * + * @module focustrapstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum FocusTrapClasses {} + export interface FocusTrapStyle extends BaseStyle {} diff --git a/components/lib/galleria/style/GalleriaStyle.d.ts b/components/lib/galleria/style/GalleriaStyle.d.ts index 20dffb1c2..bf90029ea 100644 --- a/components/lib/galleria/style/GalleriaStyle.d.ts +++ b/components/lib/galleria/style/GalleriaStyle.d.ts @@ -1,3 +1,43 @@ +/** + * + * Galleria is an advanced content gallery component. + * + * [Live Demo](https://www.primevue.org/galleria/) + * + * @module galleriastyle + * + */ import { BaseStyle } from '../../base/style'; +export enum GalleriaClasses { + mask = 'p-galleria-mask', + root = 'p-galleria', + closeButton = 'p-galleria-close-button', + closeIcon = 'p-galleria-close-icon', + header = 'p-galleria-header', + content = 'p-galleria-content', + footer = 'p-galleria-footer', + itemsContainer = 'p-galleria-items-container', + items = 'p-galleria-items', + previousItemButton = 'p-galleria-prev-button', + previousItemIcon = 'p-galleria-prev-icon', + item = 'p-galleria-item', + nextItemButton = 'p-galleria-next-button', + nextItemIcon = 'p-galleria-next-icon', + caption = 'p-galleria-caption', + indicatorList = 'p-galleria-indicator-list', + indicator = 'p-galleria-indicator', + indicatorButton = 'p-galleria-indicator-button', + thumbnails = 'p-galleria-thumbnails', + thumbnailContent = 'p-galleria-thumbnails-content', + previousThumbnailButton = 'p-galleria-thumbnail-prev-button', + previousThumbnailIcon = 'p-galleria-thumbnail-prev-icon', + thumbnailsViewport = 'p-galleria-thumbnails-viewport', + thumbnailItems = 'p-galleria-thumbnail-items', + thumbnailItem = 'p-galleria-thumbnail-item', + thumbnail = 'p-galleria-thumbnail', + nextThumbnailButton = 'p-galleria-thumbnail-next-button', + nextThumbnailIcon = 'p-galleria-thumbnail-next-icon' +} + export interface GalleriaStyle extends BaseStyle {} diff --git a/components/lib/iconfield/style/IconField.d.ts b/components/lib/iconfield/style/IconField.d.ts index 0642ad13d..92d8fb889 100644 --- a/components/lib/iconfield/style/IconField.d.ts +++ b/components/lib/iconfield/style/IconField.d.ts @@ -1,3 +1,16 @@ +/** + * + * IconField wraps an input and an icon. + * + * [Live Demo](https://www.primevue.org/inputtext/) + * + * @module iconfieldstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum IconFieldClasses { + root = 'p-iconfield' +} + export interface IconFieldStyle extends BaseStyle {} diff --git a/components/lib/image/style/ImageStyle.d.ts b/components/lib/image/style/ImageStyle.d.ts index 9d4aa512d..2b5f10c27 100644 --- a/components/lib/image/style/ImageStyle.d.ts +++ b/components/lib/image/style/ImageStyle.d.ts @@ -1,3 +1,26 @@ +/** + * + * Displays an image with preview and tranformation options. For multiple image, see Galleria. + * + * [Live Demo](https://www.primevue.org/image/) + * + * @module imagestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ImageClasses { + root = 'p-image', + previewMask = 'p-image-preview-mask', + previewIcon = 'p-image-preview-icon', + mask = 'p-image-mask', + toolbar = 'p-image-toolbar', + rotateRightButton = 'p-image-rotate-right-button', + rotateLeftButton = 'p-image-rotate-left-button', + zoomOutButton = 'p-image-zoom-out-button', + zoomInButton = 'p-image-zoom-in-button', + closeButton = 'p-image-close-button', + original = 'p-image-original' +} + export interface ImageStyle extends BaseStyle {} diff --git a/components/lib/inlinemessage/style/InlineMessageStyle.d.ts b/components/lib/inlinemessage/style/InlineMessageStyle.d.ts index 64f0f3454..4c1523e7a 100644 --- a/components/lib/inlinemessage/style/InlineMessageStyle.d.ts +++ b/components/lib/inlinemessage/style/InlineMessageStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message. + * + * [Live Demo](https://www.primevue.org/inlinemessage/) + * + * @module inlinemessagestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InlineMessageClasses { + root = 'p-inline-message', + icon = 'p-inline-message-icon', + text = 'p-inline-message-text' +} + export interface InlineMessageStyle extends BaseStyle {} diff --git a/components/lib/inplace/Inplace.d.ts b/components/lib/inplace/Inplace.d.ts index cb5f3caca..87cc79225 100755 --- a/components/lib/inplace/Inplace.d.ts +++ b/components/lib/inplace/Inplace.d.ts @@ -7,7 +7,6 @@ * @module inplace * */ - import { HTMLAttributes, VNode } from 'vue'; import { ComponentHooks } from '../basecomponent'; import { PassThroughOptions } from '../passthrough'; diff --git a/components/lib/inplace/style/InplaceStyle.d.ts b/components/lib/inplace/style/InplaceStyle.d.ts index 5c811cc6a..cabf35002 100644 --- a/components/lib/inplace/style/InplaceStyle.d.ts +++ b/components/lib/inplace/style/InplaceStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content. + * + * [Live Demo](https://www.primevue.org/inplace) + * + * @module inplacestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InplaceClasses { + root = 'p-inplace', + display = 'p-inplace-display', + content = 'p-inplace-content' +} + export interface InplaceStyle extends BaseStyle {} diff --git a/components/lib/inputchips/style/InputChipsStyle.d.ts b/components/lib/inputchips/style/InputChipsStyle.d.ts index de9b4afc0..a211f3e22 100644 --- a/components/lib/inputchips/style/InputChipsStyle.d.ts +++ b/components/lib/inputchips/style/InputChipsStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * InputChips groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/inputchips/) + * + * @module inputchipsstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputChipsClasses { + root = 'p-inputchips', + input = 'p-inputchips-input', + chip = 'p-inputchips-chip', + pcChipLabel = 'p-inputchips-chip-label', + chipIcon = 'p-inputchips-chip-icon', + inputItem = 'p-inputchips-input-item' +} + export interface InputChipsStyle extends BaseStyle {} diff --git a/components/lib/inputgroup/style/InputGroupStyle.d.ts b/components/lib/inputgroup/style/InputGroupStyle.d.ts index 3cd83c5b4..455ec2d2a 100644 --- a/components/lib/inputgroup/style/InputGroupStyle.d.ts +++ b/components/lib/inputgroup/style/InputGroupStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * InputGroup displays text, icon, buttons and other content can be grouped next to an input. + * + * [Live Demo](https://www.primevue.org/inputgroup/) + * + * @module inputgroupstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputGroupClasses { + root = 'p-inputgroup' +} + export interface InputGroupStyle extends BaseStyle {} diff --git a/components/lib/inputgroupaddon/style/InputGroupAddonStyle.d.ts b/components/lib/inputgroupaddon/style/InputGroupAddonStyle.d.ts index cbfe1a750..cc0ec9984 100644 --- a/components/lib/inputgroupaddon/style/InputGroupAddonStyle.d.ts +++ b/components/lib/inputgroupaddon/style/InputGroupAddonStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * InputGroupAddon displays text, icon, buttons and other content can be grouped next to an input. + * + * [Live Demo](https://www.primevue.org/inputgroup/) + * + * @module inputgroupaddonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputGroupAddonClasses { + root = 'p-inputgroup-addon' +} + export interface InputGroupAddonStyle extends BaseStyle {} diff --git a/components/lib/inputicon/style/InputIconStyle.d.ts b/components/lib/inputicon/style/InputIconStyle.d.ts index b182f4480..31b1298c7 100644 --- a/components/lib/inputicon/style/InputIconStyle.d.ts +++ b/components/lib/inputicon/style/InputIconStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * InputIcon displays an icon. + * + * [Live Demo](https://www.primevue.org/inputgroup/) + * + * @module inputiconstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputIconClasses { + root = 'p-inputicon' +} + export interface InputIconStyle extends BaseStyle {} diff --git a/components/lib/inputmask/style/InputMaskStyle.d.ts b/components/lib/inputmask/style/InputMaskStyle.d.ts index ae5c2fc76..7865f2e3a 100644 --- a/components/lib/inputmask/style/InputMaskStyle.d.ts +++ b/components/lib/inputmask/style/InputMaskStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone. + * + * [Live Demo](https://www.primevue.org/inputmask/) + * + * @module inputmaskstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputMaskClasses { + root = 'p-inputmask' +} + export interface InputMaskStyle extends BaseStyle {} diff --git a/components/lib/inputnumber/style/InputNumberStyle.d.ts b/components/lib/inputnumber/style/InputNumberStyle.d.ts index 5789f0360..9a08d0138 100644 --- a/components/lib/inputnumber/style/InputNumberStyle.d.ts +++ b/components/lib/inputnumber/style/InputNumberStyle.d.ts @@ -1,3 +1,20 @@ +/** + * + * InputNumber is an input component to provide numerical input. + * + * [Live Demo](https://www.primevue.org/inputnumber/) + * + * @module inputnumberstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum InputNumberClasses { + root = 'p-inputnumber', + pcInput = 'p-inputnumber-input', + buttonGroup = 'p-inputnumber-button-group', + incrementButton = 'p-inputnumber-increment-button', + decrementButton = 'p-inputnumber-decrement-button' +} + export interface InputNumberStyle extends BaseStyle {} diff --git a/components/lib/inputotp/style/InputOtpStyle.d.ts b/components/lib/inputotp/style/InputOtpStyle.d.ts index c52582775..48269f0f3 100644 --- a/components/lib/inputotp/style/InputOtpStyle.d.ts +++ b/components/lib/inputotp/style/InputOtpStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * InputOtp is used to enter one time passwords. + * + * [Live Demo](https://www.primevue.org/inputotp/) + * + * @module inputotpstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum InputOtpClasses { + root = 'p-inputotp', + pcInput = 'p-inputotp-input' +} + export interface InputOtpStyle extends BaseStyle {} diff --git a/components/lib/inputswitch/style/InputSwitchStyle.d.ts b/components/lib/inputswitch/style/InputSwitchStyle.d.ts index 0196ea577..58638d7d2 100644 --- a/components/lib/inputswitch/style/InputSwitchStyle.d.ts +++ b/components/lib/inputswitch/style/InputSwitchStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * InputSwitch is used to select a boolean value. + * + * [Live Demo](https://www.primevue.org/toggleswitch/) + * + * @module inputswitchstyle + * + */ import { ToggleSwitchStyle } from '../../toggleswitch/style/ToggleSwitchStyle'; +export enum InputSwitchClasses {} + export interface InputSwitchStyle extends ToggleSwitchStyle {} diff --git a/components/lib/inputtext/style/InputTextStyle.d.ts b/components/lib/inputtext/style/InputTextStyle.d.ts index c304196f8..075300df0 100644 --- a/components/lib/inputtext/style/InputTextStyle.d.ts +++ b/components/lib/inputtext/style/InputTextStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * InputText renders a text field to enter data. + * + * [Live Demo](https://www.primevue.org/inputtext/) + * + * @module inputtext + * + */ import { BaseStyle } from '../../base/style'; +export enum InputTextClasses { + root = 'p-inputtext' +} + export interface InputTextStyle extends BaseStyle {} diff --git a/components/lib/knob/style/KnobStyle.d.ts b/components/lib/knob/style/KnobStyle.d.ts index 96a63d1a8..e0bad02ec 100644 --- a/components/lib/knob/style/KnobStyle.d.ts +++ b/components/lib/knob/style/KnobStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * Knob is a form component to define number inputs with a dial. + * + * [Live Demo](https://www.primevue.org/knob/) + * + * @module knobstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum KnobClasses { + root = 'p-knob', + range = 'p-knob-range', + value = 'p-knob-value', + text = 'p-knob-text' +} + export interface KnobStyle extends BaseStyle {} diff --git a/components/lib/listbox/style/ListboxStyle.d.ts b/components/lib/listbox/style/ListboxStyle.d.ts index 157a2315f..805385332 100644 --- a/components/lib/listbox/style/ListboxStyle.d.ts +++ b/components/lib/listbox/style/ListboxStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * ListBox is used to select one or more values from a list of items. + * + * [Live Demo](https://www.primevue.org/listbox/) + * + * @module listboxstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ListboxClasses { + root = 'p-listbox', + header = 'p-listbox-header', + pcFilter = 'p-listbox-filter', + listContainer = 'p-listbox-list-container', + list = 'p-listbox-list', + optionGroup = 'p-listbox-option-group', + option = 'p-listbox-option', + emptyMessage = 'p-listbox-empty-message' +} + export interface ListboxStyle extends BaseStyle {} diff --git a/components/lib/megamenu/style/MegaMenuStyle.d.ts b/components/lib/megamenu/style/MegaMenuStyle.d.ts index 0013d6770..14372e138 100644 --- a/components/lib/megamenu/style/MegaMenuStyle.d.ts +++ b/components/lib/megamenu/style/MegaMenuStyle.d.ts @@ -1,3 +1,32 @@ +/** + * + * MegaMenu is navigation component that displays submenus together. + * + * [Live Demo](https://www.primevue.org/megamenu/) + * + * @module megamenustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MegaMenuClasses { + root = 'p-megamenu', + start = 'p-megamenu-start', + button = 'p-megamenu-button', + rootList = 'p-megamenu-root-list', + submenuItem = 'p-megamenu-submenu-item', + item = 'p-megamenu-item', + itemContent = 'p-megamenu-item-content', + itemLink = 'p-megamenu-item-link', + itemIcon = 'p-megamenu-item-icon', + itemLabel = 'p-megamenu-item-label', + submenuIcon = 'p-megamenu-submenu-icon', + panel = 'p-megamenu-panel', + grid = 'p-megamenu-grid', + submenu = 'p-megamenu-submenu', + submenuItemLabel = 'p-megamenu-submenu-item-label', + separator = 'p-megamenu-separator', + end = 'p-megamenu-end' +} + export interface MegaMenuStyle extends BaseStyle {} diff --git a/components/lib/menu/style/MenuStyle.d.ts b/components/lib/menu/style/MenuStyle.d.ts index be021d2fe..745a4c31e 100644 --- a/components/lib/menu/style/MenuStyle.d.ts +++ b/components/lib/menu/style/MenuStyle.d.ts @@ -1,3 +1,26 @@ +/** + * + * Menu is a navigation / command component that supports dynamic and static positioning. + * + * [Live Demo](https://www.primevue.org/menu/) + * + * @module menustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MenuClasses { + root = 'p-menu', + start = 'p-menu-start', + list = 'p-menu-list', + submenuItem = 'p-menu-submenu-item', + separator = 'p-menu-separator', + end = 'p-menu-end', + item = 'p-menu-item', + itemContent = 'p-menu-item-content', + itemLink = 'p-menu-item-link', + itemIcon = 'p-menu-item-icon', + itemLabel = 'p-menu-item-label' +} + export interface MenuStyle extends BaseStyle {} diff --git a/components/lib/menubar/style/MenubarStyle.d.ts b/components/lib/menubar/style/MenubarStyle.d.ts index 081328d1a..4b0548571 100644 --- a/components/lib/menubar/style/MenubarStyle.d.ts +++ b/components/lib/menubar/style/MenubarStyle.d.ts @@ -1,3 +1,28 @@ +/** + * + * Menubar is a horizontal menu component. + * + * [Live Demo](https://www.primevue.org/menubar/) + * + * @module menubarstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MenubarClasses { + root = 'p-menubar', + start = 'p-menubar-start', + button = 'p-menubar-button', + rootList = 'p-menubar-root-list', + item = 'p-menubar-item', + itemContent = 'p-menubar-item-content', + itemLink = 'p-menubar-item-link', + itemIcon = 'p-menubar-item-icon', + itemLabel = 'p-menubar-item-label', + submenuIcon = 'p-menubar-submenu-icon', + submenu = 'p-menubar-submenu', + separator = 'p-menubar-separator', + end = 'p-menubar-end' +} + export interface MenubarStyle extends BaseStyle {} diff --git a/components/lib/message/style/MessageStyle.d.ts b/components/lib/message/style/MessageStyle.d.ts index 0fb9952c6..4d91ed10e 100644 --- a/components/lib/message/style/MessageStyle.d.ts +++ b/components/lib/message/style/MessageStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * Message groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/message/) + * + * @module messagestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MessageClasses { + root = 'p-message', + content = 'p-message-content', + icon = 'p-message-icon', + text = 'p-message-text', + closeButton = 'p-message-close-button', + closeIcon = 'p-message-close-icon' +} + export interface MessageStyle extends BaseStyle {} diff --git a/components/lib/metergroup/MeterGroup.d.ts b/components/lib/metergroup/MeterGroup.d.ts index fd6b84f2c..cc20eeee9 100644 --- a/components/lib/metergroup/MeterGroup.d.ts +++ b/components/lib/metergroup/MeterGroup.d.ts @@ -7,7 +7,6 @@ * @module metergroup * */ - import { VNode } from 'vue'; import { PassThroughOptions } from '../passthrough'; import { ClassComponent, DesignToken, GlobalComponentConstructor, PassThrough } from '../ts-helpers'; diff --git a/components/lib/metergroup/style/MeterGroupStyle.d.ts b/components/lib/metergroup/style/MeterGroupStyle.d.ts index 4786611d2..d24dc3d26 100644 --- a/components/lib/metergroup/style/MeterGroupStyle.d.ts +++ b/components/lib/metergroup/style/MeterGroupStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * MeterGroup is a group of process status indicators. + * + * [Live Demo](https://primevue.org/metergroup) + * + * @module metergroupstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MeterGroupClasses { + root = 'p-metergroup', + meters = 'p-metergroup-meters', + meter = 'p-metergroup-meter', + labelList = 'p-metergroup-label-list', + label = 'p-metergroup-label', + labelIcon = 'p-metergroup-label-icon', + labelMarker = 'p-metergroup-label-marker', + labelText = 'p-metergroup-label-text' +} + export interface MeterGroupStyle extends BaseStyle {} diff --git a/components/lib/multiselect/style/MultiSelectStyle.d.ts b/components/lib/multiselect/style/MultiSelectStyle.d.ts index 6e29936ec..2b3b8b986 100644 --- a/components/lib/multiselect/style/MultiSelectStyle.d.ts +++ b/components/lib/multiselect/style/MultiSelectStyle.d.ts @@ -1,3 +1,33 @@ +/** + * + * MultiSelect is used to select multiple items from a collection. + * + * [Live Demo](https://www.primevue.org/multiselect/) + * + * @module multiselectstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum MultiSelectClasses { + root = 'p-multiselect', + labelContainer = 'p-multiselect-label-container', + label = 'p-multiselect-label', + chip = 'p-multiselect-chip', + pcChipLabel = 'p-multiselect-chip-label', + chipIcon = 'p-multiselect-chip-icon', + dropdown = 'p-multiselect-dropdown', + loadingIcon = 'p-multiselect-loading-icon', + dropdownIcon = 'p-multiselect-dropdown-icon', + overlay = 'p-multiselect-overlay', + header = 'p-multiselect-header', + pcFilterContainer = 'p-multiselect-filter-container', + pcFilter = 'p-multiselect-filter', + listContainer = 'p-multiselect-list-container', + list = 'p-multiselect-list', + optionGroup = 'p-multiselect-option-group', + option = 'p-multiselect-option', + emptyMessage = 'p-multiselect-empty-message' +} + export interface MultiSelectStyle extends BaseStyle {} diff --git a/components/lib/orderlist/style/OrderListStyle.d.ts b/components/lib/orderlist/style/OrderListStyle.d.ts index 1d2eebfaa..2c6c852d3 100644 --- a/components/lib/orderlist/style/OrderListStyle.d.ts +++ b/components/lib/orderlist/style/OrderListStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * OrderList is used to managed the order of a collection. + * + * [Live Demo](https://primevue.org/orderlist) + * + * @module orderliststyle + * + */ import { BaseStyle } from '../../base/style'; +export enum OrderListClasses { + root = 'p-orderlist', + controls = 'p-orderlist-controls' +} + export interface OrderListStyle extends BaseStyle {} diff --git a/components/lib/organizationchart/style/OrganizationChartStyle.d.ts b/components/lib/organizationchart/style/OrganizationChartStyle.d.ts index 2ab16d6f3..50372001b 100644 --- a/components/lib/organizationchart/style/OrganizationChartStyle.d.ts +++ b/components/lib/organizationchart/style/OrganizationChartStyle.d.ts @@ -1,3 +1,25 @@ +/** + * + * OrganizationChart visualizes hierarchical organization data. + * + * [Live Demo](https://primevue.org/organizationchart) + * + * @module organizationchartstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum OrganizationChartClasses { + root = 'p-organizationchart', + table = 'p-organizationchart-table', + node = 'p-organizationchart-node', + nodeToggleButton = 'p-organizationchart-node-toggle-button', + nodeToggleButtonIcon = 'p-organizationchart-node-toggle-button-icon', + connectors = 'p-organizationchart-connectors', + connectorDown = 'p-organizationchart-connector-down', + connectorLeft = 'p-organizationchart-connector-left', + connectorRight = 'p-organizationchart-connector-right', + nodeChildren = 'p-organizationchart-node-children' +} + export interface OrganizationChartStyle extends BaseStyle {} diff --git a/components/lib/overlaypanel/style/OverlayPanelStyle.d.ts b/components/lib/overlaypanel/style/OverlayPanelStyle.d.ts index 545a6dfd0..6193bee56 100644 --- a/components/lib/overlaypanel/style/OverlayPanelStyle.d.ts +++ b/components/lib/overlaypanel/style/OverlayPanelStyle.d.ts @@ -1,3 +1,12 @@ +/** + * + * OverlayPanel is a container component positioned as connected to its target. + * + * [Live Demo](https://primevue.org/popover) + * + * @module overlaypanelstyle + * + */ import { PopoverStyle } from '../../popover/style/PopoverStyle'; export interface OverlayPanelStyle extends PopoverStyle {} diff --git a/components/lib/paginator/style/PaginatorStyle.d.ts b/components/lib/paginator/style/PaginatorStyle.d.ts index 026489e50..25152f783 100644 --- a/components/lib/paginator/style/PaginatorStyle.d.ts +++ b/components/lib/paginator/style/PaginatorStyle.d.ts @@ -1,3 +1,32 @@ +/** + * + * Paginator is a generic component to display content in paged format. + * + * [Live Demo](https://primevue.org/paginator) + * + * @module paginatorstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PaginatorClasses { + paginator = 'p-paginator', + contentStart = 'p-paginator-content-start', + contentEnd = 'p-paginator-content-end', + first = 'p-paginator-first', + firstIcon = 'p-paginator-first-icon', + prev = 'p-paginator-prev', + prevIcon = 'p-paginator-prev-icon', + next = 'p-paginator-next', + nextIcon = 'p-paginator-next-icon', + last = 'p-paginator-last', + lastIcon = 'p-paginator-last-icon', + pages = 'p-paginator-pages', + page = 'p-paginator-page', + current = 'p-paginator-current', + pcRowPerPageDropdown = 'p-paginator-rpp-dropdown', + pcJumpToPageDropdown = 'p-paginator-jtp-dropdown', + pcJumpToPageInput = 'p-paginator-jtp-input' +} + export interface PaginatorStyle extends BaseStyle {} diff --git a/components/lib/panel/style/PanelStyle.d.ts b/components/lib/panel/style/PanelStyle.d.ts index d2cd23f1e..3a9d2a3d2 100644 --- a/components/lib/panel/style/PanelStyle.d.ts +++ b/components/lib/panel/style/PanelStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * Panel is a container with the optional content toggle feature. + * + * [Live Demo](https://www.primevue.org/panel/) + * + * @module panelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PanelClasses { + root = 'p-panel', + header = 'p-panel-header', + title = 'p-panel-title', + headerActions = 'p-panel-header-actions', + pcToggleButton = 'p-panel-toggle-button', + contentContainer = 'p-panel-content-container', + content = 'p-panel-content', + footer = 'p-panel-footer' +} + export interface PanelStyle extends BaseStyle {} diff --git a/components/lib/panelmenu/style/PanelMenuStyle.d.ts b/components/lib/panelmenu/style/PanelMenuStyle.d.ts index 001651b4e..bb01cb60e 100644 --- a/components/lib/panelmenu/style/PanelMenuStyle.d.ts +++ b/components/lib/panelmenu/style/PanelMenuStyle.d.ts @@ -1,3 +1,33 @@ +/** + * + * PanelMenu is a hybrid of Accordion and Tree components. + * + * [Live Demo](https://www.primevue.org/panelmenu/) + * + * @module panelmenustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PanelMenuClasses { + root = 'p-panelmenu', + panel = 'p-panelmenu-panel', + header = 'p-panelmenu-header', + headerContent = 'p-panelmenu-header-content', + headerLink = 'p-panelmenu-header-link', + headerIcon = 'p-panelmenu-header-icon', + headerLabel = 'p-panelmenu-header-label', + contentContainer = 'p-panelmenu-content-container', + content = 'p-panelmenu-content', + rootList = 'p-panelmenu-root-list', + item = 'p-panelmenu-item', + itemContent = 'p-panelmenu-item-content', + itemLink = 'p-panelmenu-item-link', + itemIcon = 'p-panelmenu-item-icon', + itemLabel = 'p-panelmenu-item-label', + submenuIcon = 'p-panelmenu-submenu-icon', + submenu = 'p-panelmenu-submenu', + separator = 'p-menuitem-separator' +} + export interface PanelMenuStyle extends BaseStyle {} diff --git a/components/lib/password/style/PasswordStyle.d.ts b/components/lib/password/style/PasswordStyle.d.ts index 661ac7496..0501f51e3 100644 --- a/components/lib/password/style/PasswordStyle.d.ts +++ b/components/lib/password/style/PasswordStyle.d.ts @@ -1,3 +1,23 @@ +/** + * + * Password displays strength indicator for password fields. + * + * [Live Demo](https://www.primevue.org/password/) + * + * @module passwordstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PasswordClasses { + root = 'p-password', + ptInput = 'p-password-input', + maskIcon = 'p-password-mask-icon', + unmaskIcon = 'p-password-unmask-icon', + overlay = 'p-password-overlay', + meter = 'p-password-meter', + meterLabel = 'p-password-meter-label', + meterText = 'p-password-meter-text' +} + export interface PasswordStyle extends BaseStyle {} diff --git a/components/lib/picklist/style/PickListStyle.d.ts b/components/lib/picklist/style/PickListStyle.d.ts index cc713eb1d..bc59121ab 100644 --- a/components/lib/picklist/style/PickListStyle.d.ts +++ b/components/lib/picklist/style/PickListStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * PickList is used to reorder items between different lists. + * + * [Live Demo](https://primevue.org/picklist) + * + * @module pickliststyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PickListClasses { + root = 'p-picklist', + sourceControls = 'p-picklist-source-controls', + sourceListContainer = 'p-picklist-source-list-container', + transferControls = 'p-picklist-transfer-controls', + targetListContainer = 'p-picklist-target-list-container', + targetControls = 'p-picklist-target-controls' +} + export interface PickListStyle extends BaseStyle {} diff --git a/components/lib/popover/style/PopoverStyle.d.ts b/components/lib/popover/style/PopoverStyle.d.ts index fa132056f..752d231a9 100644 --- a/components/lib/popover/style/PopoverStyle.d.ts +++ b/components/lib/popover/style/PopoverStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * Popover is a container component positioned as connected to its target. + * + * [Live Demo](https://primevue.org/popover) + * + * @module popoverstyle + * + */ import { BaseStyle } from '../../base/style/BaseStyle'; +export enum PopoverClasses { + root = 'p-popover', + content = 'p-popover-content' +} + export interface PopoverStyle extends BaseStyle {} diff --git a/components/lib/portal/style/PortalStyle.d.ts b/components/lib/portal/style/PortalStyle.d.ts index e9cc9c0c7..d26b3101f 100644 --- a/components/lib/portal/style/PortalStyle.d.ts +++ b/components/lib/portal/style/PortalStyle.d.ts @@ -1,3 +1,12 @@ +/** + * + * [Live Demo](https://primevue.org/) + * + * @module portalstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum PortalClasses {} + export interface PortalStyle extends BaseStyle {} diff --git a/components/lib/progressbar/style/ProgressBarStyle.d.ts b/components/lib/progressbar/style/ProgressBarStyle.d.ts index 727c4b357..7e752d6df 100644 --- a/components/lib/progressbar/style/ProgressBarStyle.d.ts +++ b/components/lib/progressbar/style/ProgressBarStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * ProgressBar is a process status indicator. + * + * [Live Demo](https://www.primevue.org/progressbar) + * + * @module progressbarstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ProgressBarClasses { + root = 'p-progressbar', + indeterminateContainer = 'p-progressbar-indeterminate-container', + value = 'p-progressbar-value', + label = 'p-progressbar-label' +} + export interface ProgressBarStyle extends BaseStyle {} diff --git a/components/lib/progressspinner/style/ProgressSpinnerStyle.d.ts b/components/lib/progressspinner/style/ProgressSpinnerStyle.d.ts index 62e871885..32927954c 100644 --- a/components/lib/progressspinner/style/ProgressSpinnerStyle.d.ts +++ b/components/lib/progressspinner/style/ProgressSpinnerStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * ProgressSpinner is a process status indicator. + * + * [Live Demo](https://www.primevue.org/progressspinner) + * + * @module progressspinnerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ProgressSpinnerClasses { + root = 'p-progressspinner', + spin = 'p-progressspinner-spin', + circle = 'p-progressspinner-circle' +} + export interface ProgressSpinnerStyle extends BaseStyle {} diff --git a/components/lib/radiobutton/style/RadioButtonStyle.d.ts b/components/lib/radiobutton/style/RadioButtonStyle.d.ts index 088bad4e9..90801e797 100644 --- a/components/lib/radiobutton/style/RadioButtonStyle.d.ts +++ b/components/lib/radiobutton/style/RadioButtonStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * RadioButton is an extension to standard radio button element with theming. + * + * [Live Demo](https://www.primevue.org/radiobutton/) + * + * @module radiobuttonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum RadioButtonClasses { + root = 'p-radiobutton', + box = 'p-radiobutton-box', + input = 'p-radiobutton-input', + icon = 'p-radiobutton-icon' +} + export interface RadioButtonStyle extends BaseStyle {} diff --git a/components/lib/rating/style/RatingStyle.d.ts b/components/lib/rating/style/RatingStyle.d.ts index fa8b083b2..e6b682408 100644 --- a/components/lib/rating/style/RatingStyle.d.ts +++ b/components/lib/rating/style/RatingStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * Rating component is a star based selection input. + * + * [Live Demo](https://www.primevue.org/rating/) + * + * @module ratingstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum RatingClasses { + root = 'p-rating', + option = 'p-rating-option', + onIcon = 'p-rating-on-icon', + offIcon = 'p-rating-off-icon' +} + export interface RatingStyle extends BaseStyle {} diff --git a/components/lib/ripple/Ripple.d.ts b/components/lib/ripple/Ripple.d.ts index 81ab5aa2b..5e5ad3a46 100644 --- a/components/lib/ripple/Ripple.d.ts +++ b/components/lib/ripple/Ripple.d.ts @@ -5,6 +5,7 @@ * [Live Demo](https://primevue.org/ripple) * * @module ripple + * */ import { DirectiveBinding, ObjectDirective } from 'vue'; import { DirectiveHooks } from '../basedirective'; diff --git a/components/lib/ripple/style/RippleStyle.d.ts b/components/lib/ripple/style/RippleStyle.d.ts index ab0cac909..e39f30372 100644 --- a/components/lib/ripple/style/RippleStyle.d.ts +++ b/components/lib/ripple/style/RippleStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Ripple directive adds ripple effect to the host element. + * + * [Live Demo](https://primevue.org/ripple) + * + * @module ripplestyle + * + */ import { BaseStyle } from '../../base/style'; -export interface AccordionStyle extends BaseStyle {} +export enum RippleClasses { + root = 'p-ink' +} + +export interface RippleStyle extends BaseStyle {} diff --git a/components/lib/row/Row.d.ts b/components/lib/row/Row.d.ts index f4d596ffc..576068ea6 100755 --- a/components/lib/row/Row.d.ts +++ b/components/lib/row/Row.d.ts @@ -1,9 +1,11 @@ /** + * * Row component is a helper component used to create grouping structures in DataTable. * * [Live Demo](https://www.primevue.org/datatable/) * * @module row + * */ import { ComponentHooks } from '../basecomponent'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; diff --git a/components/lib/row/style/RowStyle.d.ts b/components/lib/row/style/RowStyle.d.ts index f8eb8c4bd..b5a1b0a89 100644 --- a/components/lib/row/style/RowStyle.d.ts +++ b/components/lib/row/style/RowStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Row component is a helper component used to create grouping structures in DataTable. + * + * [Live Demo](https://www.primevue.org/datatable/) + * + * @module rowstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum RowClasses {} + export interface RowStyle extends BaseStyle {} diff --git a/components/lib/scrollpanel/style/ScrollPanelStyle.d.ts b/components/lib/scrollpanel/style/ScrollPanelStyle.d.ts index 73b062bb8..5ee400309 100644 --- a/components/lib/scrollpanel/style/ScrollPanelStyle.d.ts +++ b/components/lib/scrollpanel/style/ScrollPanelStyle.d.ts @@ -1,3 +1,20 @@ +/** + * + * ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar. + * + * [Live Demo](https://www.primevue.org/scrollpanel/) + * + * @module scrollpanelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ScrollPanelClasses { + root = 'p-scrollpanel', + contentContainer = 'p-scrollpanel-content-container', + content = 'p-scrollpanel-content', + barX = 'p-scrollpanel-bar-x', + barY = 'p-scrollpanel-bar-y' +} + export interface ScrollPanelStyle extends BaseStyle {} diff --git a/components/lib/scrolltop/style/ScrollTopStyle.d.ts b/components/lib/scrolltop/style/ScrollTopStyle.d.ts index dbfd33ed2..ada6d3ffa 100644 --- a/components/lib/scrolltop/style/ScrollTopStyle.d.ts +++ b/components/lib/scrolltop/style/ScrollTopStyle.d.ts @@ -1,3 +1,17 @@ +/** + * + * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly. + * + * [Live Demo](https://www.primevue.org/scrolltop/) + * + * @module scrolltopstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ScrollTopClasses { + root = 'p-scrolltop', + icon = 'p-scrolltop-icon' +} + export interface ScrollTopStyle extends BaseStyle {} diff --git a/components/lib/select/style/SelectStyle.d.ts b/components/lib/select/style/SelectStyle.d.ts index 89deac6fb..3b0f5630f 100644 --- a/components/lib/select/style/SelectStyle.d.ts +++ b/components/lib/select/style/SelectStyle.d.ts @@ -1,3 +1,33 @@ +/** + * + * Select also known as Select, is used to choose an item from a collection of options. + * + * [Live Demo](https://www.primevue.org/select/) + * + * @module selectstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SelectClasses { + root = 'p-select', + label = 'p-select-label', + clearIcon = 'p-select-clear-icon', + dropdown = 'p-select-dropdown', + loadingicon = 'p-select-loading-icon', + dropdownIcon = 'p-select-dropdown-icon', + overlay = 'p-select-overlay', + header = 'p-select-header', + pcFilter = 'p-select-filter', + listContainer = 'p-select-list-container', + list = 'p-select-list', + optionGroup = 'p-select-option-group', + optionGroupLabel = 'p-select-option-group-label', + option = 'p-select-option', + optionLabel = 'p-select-option-label', + optionCheckIcon = 'p-select-option-check-icon', + optionBlankIcon = 'p-select-option-blank-icon', + emptyMessage = 'p-select-empty-message' +} + export interface SelectStyle extends BaseStyle {} diff --git a/components/lib/selectbutton/style/SelectButtonStyle.d.ts b/components/lib/selectbutton/style/SelectButtonStyle.d.ts index 99ac8d726..18bc7ef25 100644 --- a/components/lib/selectbutton/style/SelectButtonStyle.d.ts +++ b/components/lib/selectbutton/style/SelectButtonStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * SelectButton is used to choose single or multiple items from a list using buttons. + * + * [Live Demo](https://www.primevue.org/selectbutton/) + * + * @module selectbuttonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SelectButtonClasses { + root = 'p-selectbutton' +} + export interface SelectButtonStyle extends BaseStyle {} diff --git a/components/lib/sidebar/style/SidebarStyle.d.ts b/components/lib/sidebar/style/SidebarStyle.d.ts index 8c10b3b40..cf67b8119 100644 --- a/components/lib/sidebar/style/SidebarStyle.d.ts +++ b/components/lib/sidebar/style/SidebarStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * Sidebar is a panel component displayed as an overlay at the edges of the screen. + * + * [Live Demo](https://primevue.org/drawer) + * + * @module sidebarstyle + * + */ import { DrawerStyle } from '../../drawer/style/DrawerStyle'; +export enum SidebarClasses {} + export interface SidebarStyle extends DrawerStyle {} diff --git a/components/lib/skeleton/style/SkeletonStyle.d.ts b/components/lib/skeleton/style/SkeletonStyle.d.ts index 27a67ee07..077eaad79 100644 --- a/components/lib/skeleton/style/SkeletonStyle.d.ts +++ b/components/lib/skeleton/style/SkeletonStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Skeleton is a placeholder to display instead of the actual content. + * + * [Live Demo](https://www.primevue.org/skeleton/) + * + * @module skeletonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SkeletonClasses { + root = 'p-skeleton' +} + export interface SkeletonStyle extends BaseStyle {} diff --git a/components/lib/slider/style/SliderStyle.d.ts b/components/lib/slider/style/SliderStyle.d.ts index 6444808b3..8e64ce25c 100644 --- a/components/lib/slider/style/SliderStyle.d.ts +++ b/components/lib/slider/style/SliderStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Slider is a component to provide input with a drag handle. + * + * [Live Demo](https://www.primevue.org/slider/) + * + * @module sliderstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SliderClasses { + root = 'p-slider', + range = 'p-slider-range', + handle = 'p-slider-handle' +} + export interface SliderStyle extends BaseStyle {} diff --git a/components/lib/speeddial/style/SpeedDialStyle.d.ts b/components/lib/speeddial/style/SpeedDialStyle.d.ts index 2c6d7405d..fb2a32d2a 100644 --- a/components/lib/speeddial/style/SpeedDialStyle.d.ts +++ b/components/lib/speeddial/style/SpeedDialStyle.d.ts @@ -1,3 +1,22 @@ +/** + * + * When pressed, a floating action button can display multiple primary actions that can be performed on a page. + * + * [Live Demo](https://www.primevue.org/speeddial/) + * + * @module speeddialstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SpeedDialClasses { + root = 'p-speeddial', + pcButton = 'p-speeddial-button', + list = 'p-speeddial-list', + item = 'p-speeddial-item', + action = 'p-speeddial-action', + actionIcon = 'p-speeddial-action-icon', + mask = 'p-speeddial-mask' +} + export interface SpeedDialStyle extends BaseStyle {} diff --git a/components/lib/splitbutton/style/SplitButtonStyle.d.ts b/components/lib/splitbutton/style/SplitButtonStyle.d.ts index a2aa74e2d..77f645b11 100644 --- a/components/lib/splitbutton/style/SplitButtonStyle.d.ts +++ b/components/lib/splitbutton/style/SplitButtonStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * SplitButton groups a set of commands in an overlay with a default command. + * + * [Live Demo](https://www.primevue.org/splitbutton/) + * + * @module splitbuttonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SplitButtonClasses { + root = 'p-splitbutton', + pcButton = 'p-splitbutton-button', + pcDropdown = 'p-splitbutton-dropdown' +} + export interface SplitButtonStyle extends BaseStyle {} diff --git a/components/lib/splitter/style/SplitterStyle.d.ts b/components/lib/splitter/style/SplitterStyle.d.ts index 414c299d5..43d60b75d 100644 --- a/components/lib/splitter/style/SplitterStyle.d.ts +++ b/components/lib/splitter/style/SplitterStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Splitter is utilized to separate and resize panels. + * + * [Live Demo](https://www.primevue.org/splitter/) + * + * @module splitterstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SplitterClasses { + root = 'p-splitter', + gutter = 'p-splitter-gutter', + gutterHandle = 'p-splitter-gutter-handle' +} + export interface SplitterStyle extends BaseStyle {} diff --git a/components/lib/splitterpanel/style/SplitterPanelStyle.d.ts b/components/lib/splitterpanel/style/SplitterPanelStyle.d.ts index 8f833d049..6b37f7469 100644 --- a/components/lib/splitterpanel/style/SplitterPanelStyle.d.ts +++ b/components/lib/splitterpanel/style/SplitterPanelStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * SplitterPanel is a helper component for Splitter component. + * + * [Live Demo](https://www.primevue.org/splitter/) + * + * @module splitterpanelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum SplitterPanelClasses { + root = 'p-splitter-panel' +} + export interface SplitterPanelStyle extends BaseStyle {} diff --git a/components/lib/stepper/style/StepperStyle.d.ts b/components/lib/stepper/style/StepperStyle.d.ts index 91b9eb2ff..389973faa 100644 --- a/components/lib/stepper/style/StepperStyle.d.ts +++ b/components/lib/stepper/style/StepperStyle.d.ts @@ -1,3 +1,26 @@ +/** + * + * Stepper is a component that streamlines a wizard-like workflow, organizing content into coherent steps and visually guiding users through a numbered progression in a multi-step process. + * + * [Live Demo](https://www.primevue.org/stepper/) + * + * @module stepperstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum StepperClasses { + root = 'p-stepper', + list = 'p-stepper-list', + stepperItem = 'p-stepper-item', + stepperItemHeader = 'p-stepper-item-header', + stepperItemNumber = 'p-stepper-item-number', + stepperItemTitle = 'p-stepper-item-title', + stepperSeparator = 'p-stepper-separator', + stepperPanelContentContainer = 'p-stepper-panel-content-container', + stepperPanelContent = 'p-stepper-panel-content', + panels = 'p-stepper-panels', + panel = 'p-stepper-panel' +} + export interface StepperStyle extends BaseStyle {} diff --git a/components/lib/stepperpanel/style/StepperPanelStyle.d.ts b/components/lib/stepperpanel/style/StepperPanelStyle.d.ts index 7738f1455..f61f27dc4 100644 --- a/components/lib/stepperpanel/style/StepperPanelStyle.d.ts +++ b/components/lib/stepperpanel/style/StepperPanelStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * StepperPanel is a helper component for Stepper component. + * + * [Live Demo](https://www.primevue.org/stepper/) + * + * @module stepperpanelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum StepperPanelClasses {} + export interface StepperPanelStyle extends BaseStyle {} diff --git a/components/lib/steps/style/StepsStyle.d.ts b/components/lib/steps/style/StepsStyle.d.ts index b94f5e829..1389e7695 100644 --- a/components/lib/steps/style/StepsStyle.d.ts +++ b/components/lib/steps/style/StepsStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * Steps components is an indicator for the steps in a wizard workflow. Example below uses nested routes with Steps. + * + * [Live Demo](https://www.primevue.org/steps/) + * + * @module stepsstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum StepsClasses { + root = 'p-steps', + list = 'p-steps-list', + item = 'p-steps-item', + itemLink = 'p-steps-item-link', + itemNumber = 'p-steps-item-number', + itemLabel = 'p-steps-item-label' +} + export interface StepsStyle extends BaseStyle {} diff --git a/components/lib/styleclass/StyleClass.d.ts b/components/lib/styleclass/StyleClass.d.ts index 6241bf827..59a7d4d1a 100644 --- a/components/lib/styleclass/StyleClass.d.ts +++ b/components/lib/styleclass/StyleClass.d.ts @@ -5,6 +5,7 @@ * [Live Demo](https://primevue.org/styleclass) * * @module styleclass + * */ import { DirectiveBinding, ObjectDirective } from 'vue'; import { DirectiveHooks } from '../basedirective'; diff --git a/components/lib/styleclass/style/StyleClassStyle.d.ts b/components/lib/styleclass/style/StyleClassStyle.d.ts index 178660354..999cebfd8 100644 --- a/components/lib/styleclass/style/StyleClassStyle.d.ts +++ b/components/lib/styleclass/style/StyleClassStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element. + * + * [Live Demo](https://primevue.org/styleclass) + * + * @module styleclassstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum StyleClassClasses {} + export interface StyleClassStyle extends BaseStyle {} diff --git a/components/lib/tab/style/TabStyle.d.ts b/components/lib/tab/style/TabStyle.d.ts index 8c45afb8a..ead51f61b 100644 --- a/components/lib/tab/style/TabStyle.d.ts +++ b/components/lib/tab/style/TabStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Tab is a helper component for Tabs component. + * + * [Live Demo](https://www.primevue.org/tabs/) + * + * @module tabstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TabClasses { + root = 'p-tab' +} + export interface TabStyle extends BaseStyle {} diff --git a/components/lib/tablist/style/TabListStyle.d.ts b/components/lib/tablist/style/TabListStyle.d.ts index bc782dda2..077197080 100644 --- a/components/lib/tablist/style/TabListStyle.d.ts +++ b/components/lib/tablist/style/TabListStyle.d.ts @@ -1,3 +1,21 @@ +/** + * + * TabList is a helper component for Tabs component. + * + * [Live Demo](https://www.primevue.org/tabs/) + * + * @module tabliststyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TabListClasses { + root = 'p-tablist', + content = 'p-tablist-content', + tabs = 'p-tablist-tab-list', + inkbar = 'p-tablist-active-bar', + previousButton = 'p-tablist-prev-button', + nextButton = 'p-tablist-next-button' +} + export interface TabListStyle extends BaseStyle {} diff --git a/components/lib/tabmenu/style/TabMenuStyle.d.ts b/components/lib/tabmenu/style/TabMenuStyle.d.ts index ce8d83750..68837d35d 100644 --- a/components/lib/tabmenu/style/TabMenuStyle.d.ts +++ b/components/lib/tabmenu/style/TabMenuStyle.d.ts @@ -1,3 +1,22 @@ +/** + * + * TabMenu is a navigation component that displays items as tab headers. Example below uses nested routes with TabMenu. + * + * [Live Demo](https://www.primevue.org/tabmenu/) + * + * @module tabmenustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TabMenuClasses { + root = 'p-tabmenu', + tablist = 'p-tabmenu-tablist', + item = 'p-tabmenu-item', + itemLink = 'p-tabmenu-item-link', + itemIcon = 'p-tabmenu-item-icon', + itemLabel = 'p-tabmenu-item-label', + inkbar = 'p-tabmenu-ink-bar' +} + export interface TabMenuStyle extends BaseStyle {} diff --git a/components/lib/tabpanel/style/TabPanelStyle.d.ts b/components/lib/tabpanel/style/TabPanelStyle.d.ts index 485c67062..4480c91a3 100644 --- a/components/lib/tabpanel/style/TabPanelStyle.d.ts +++ b/components/lib/tabpanel/style/TabPanelStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * TabPanel is a helper component for Tabs component. + * + * [Live Demo](https://www.primevue.org/tabs/) + * + * @module tabpanelstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TabPanelClasses { + root = 'p-tabpanel' +} + export interface TabPanelStyle extends BaseStyle {} diff --git a/components/lib/tabpanels/style/TabPanelsStyle.d.ts b/components/lib/tabpanels/style/TabPanelsStyle.d.ts index 1145d89f0..c3968dea4 100644 --- a/components/lib/tabpanels/style/TabPanelsStyle.d.ts +++ b/components/lib/tabpanels/style/TabPanelsStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * TabPanels is a helper component for Tabs component. + * + * [Live Demo](https://www.primevue.org/tabs/) + * + * @module tabpanelsstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TabPanelsClasses { + root = 'p-tabpanels' +} + export interface TabPanelsStyle extends BaseStyle {} diff --git a/components/lib/tabs/style/TabsStyle.d.ts b/components/lib/tabs/style/TabsStyle.d.ts index a15edfce2..6d061bd31 100644 --- a/components/lib/tabs/style/TabsStyle.d.ts +++ b/components/lib/tabs/style/TabsStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Tabs facilitates seamless switching between different views. + * + * [Live Demo](https://www.primevue.org/tabs/) + * + * @module tabs + * + */ import { BaseStyle } from '../../base/style'; +export enum TabsClasses { + root = 'p-tabs' +} + export interface TabsStyle extends BaseStyle {} diff --git a/components/lib/tabview/style/TabViewStyle.d.ts b/components/lib/tabview/style/TabViewStyle.d.ts index 4ae8bb477..f5846c2c4 100644 --- a/components/lib/tabview/style/TabViewStyle.d.ts +++ b/components/lib/tabview/style/TabViewStyle.d.ts @@ -1,3 +1,28 @@ +/** + * @deprecated since v4. Use Tabs component instead. + * + * TabView is a container component to group content with tabs. + * + * [Live Demo](https://www.primevue.org/tabview/) + * + * @module tabview + * + */ import { BaseStyle } from '../../base/style'; +export enum TabViewClasses { + root = 'p-tabview', + navContainer = 'p-tabview-tablist-container', + previousButton = 'p-tabview-prev-button', + navContent = 'p-tabview-tablist-scroll-container', + nav = 'p-tabview-tablist', + tabHeader = 'p-tabview-tablist-item', + tabHeaderAction = 'p-tabview-tab-header', + tabHeaderTitle = 'p-tabview-tab-title', + tabContent = 'p-tabview-panel', + inkbar = 'p-tabview-ink-bar', + nextButton = 'p-tabview-next-button', + panelContainer = 'p-tabview-panels' +} + export interface TabViewStyle extends BaseStyle {} diff --git a/components/lib/tag/style/TagStyle.d.ts b/components/lib/tag/style/TagStyle.d.ts index 7c8bc8e1e..52868be5b 100644 --- a/components/lib/tag/style/TagStyle.d.ts +++ b/components/lib/tag/style/TagStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Tag component is used to categorize content. + * + * [Live Demo](https://www.primevue.org/tag) + * + * @module tagstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TagClasses { + root = 'p-tag', + icon = 'p-tag-icon', + label = 'p-tag-label' +} + export interface TagStyle extends BaseStyle {} diff --git a/components/lib/terminal/style/TerminalStyle.d.ts b/components/lib/terminal/style/TerminalStyle.d.ts index aa07ebc51..c9ebddd53 100644 --- a/components/lib/terminal/style/TerminalStyle.d.ts +++ b/components/lib/terminal/style/TerminalStyle.d.ts @@ -1,3 +1,24 @@ +/** + * + * Terminal is a text based user interface. + * + * [Live Demo](https://www.primevue.org/terminal) + * + * @module terminalstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TerminalClasses { + root = 'p-terminal', + welcomeMessage = 'p-terminal-welcome-message', + commandList = 'p-terminal-command-list', + command = 'p-terminal-command', + commandValue = 'p-terminal-command-value', + commandResponse = 'p-terminal-command-response', + prompt = 'p-terminal-prompt', + promptLabel = 'p-terminal-prompt-label', + promptValue = 'p-terminal-prompt-value' +} + export interface TerminalStyle extends BaseStyle {} diff --git a/components/lib/textarea/style/TextareaStyle.d.ts b/components/lib/textarea/style/TextareaStyle.d.ts index 851c2ac32..03664db93 100644 --- a/components/lib/textarea/style/TextareaStyle.d.ts +++ b/components/lib/textarea/style/TextareaStyle.d.ts @@ -1,3 +1,16 @@ +/** + * + * Textarea is a multi-line text input element. + * + * [Live Demo](https://www.primevue.org/textarea/) + * + * @module textareastyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TextareaClasses { + root = 'p-inputtextarea' +} + export interface TextareaStyle extends BaseStyle {} diff --git a/components/lib/tieredmenu/style/TieredMenuStyle.d.ts b/components/lib/tieredmenu/style/TieredMenuStyle.d.ts index e09d03d02..beb11e52e 100644 --- a/components/lib/tieredmenu/style/TieredMenuStyle.d.ts +++ b/components/lib/tieredmenu/style/TieredMenuStyle.d.ts @@ -1,3 +1,27 @@ +/** + * + * TieredMenu displays submenus in nested overlays. + * + * [Live Demo](https://www.primevue.org/menu/) + * + * @module tieredmenustyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TieredMenuClasses { + root = 'p-tieredmenu', + start = 'p-tieredmenu-start', + rootList = 'p-tieredmenu-root-list', + item = 'p-tieredmenu-item', + itemContent = 'p-tieredmenu-item-content', + itemLink = 'p-tieredmenu-item-link', + itemIcon = 'p-tieredmenu-item-icon', + itemLabel = 'p-tieredmenu-item-label', + submenuIcon = 'p-tieredmenu-submenu-icon', + submenu = 'p-tieredmenu-submenu', + separator = 'p-tieredmenu-separator', + end = 'p-tieredmenu-end' +} + export interface TieredMenuStyle extends BaseStyle {} diff --git a/components/lib/timeline/Timeline.d.ts b/components/lib/timeline/Timeline.d.ts index bfb83710d..4840bba08 100644 --- a/components/lib/timeline/Timeline.d.ts +++ b/components/lib/timeline/Timeline.d.ts @@ -5,6 +5,7 @@ * [Live Demo](https://primevue.org/timeline) * * @module timeline + * */ import { VNode } from 'vue'; import { ComponentHooks } from '../basecomponent'; diff --git a/components/lib/timeline/style/TimelineStyle.d.ts b/components/lib/timeline/style/TimelineStyle.d.ts index 0c00b0908..1d1039a97 100644 --- a/components/lib/timeline/style/TimelineStyle.d.ts +++ b/components/lib/timeline/style/TimelineStyle.d.ts @@ -1,3 +1,22 @@ +/** + * + * Timeline visualizes a series of chained events. + * + * [Live Demo](https://primevue.org/timeline) + * + * @module timelinestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TimelineClasses { + root = 'p-timeline', + event = 'p-timeline-event', + eventOpposite = 'p-timeline-event-opposite', + eventSeparator = 'p-timeline-event-separator', + eventMarker = 'p-timeline-event-marker', + eventConnector = 'p-timeline-event-connector', + eventContent = 'p-timeline-event-content' +} + export interface TimelineStyle extends BaseStyle {} diff --git a/components/lib/toast/style/ToastStyle.d.ts b/components/lib/toast/style/ToastStyle.d.ts index d94d1bee6..6930e31d1 100644 --- a/components/lib/toast/style/ToastStyle.d.ts +++ b/components/lib/toast/style/ToastStyle.d.ts @@ -1,3 +1,24 @@ +/** + * + * Toast is used to display messages in an overlay. + * + * [Live Demo](https://www.primevue.org/toast/) + * + * @module toaststyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ToastClasses { + root = 'p-toast', + message = 'p-toast-message', + messageContent = 'p-toast-message-content', + messageIcon = 'p-toast-message-icon', + messageText = 'p-toast-message-text', + summary = 'p-toast-summary', + detail = 'p-toast-detail', + closeButton = 'p-toast-close-button', + closeIcon = 'p-toast-close-icon' +} + export interface ToastStyle extends BaseStyle {} diff --git a/components/lib/togglebutton/style/ToggleButtonStyle.d.ts b/components/lib/togglebutton/style/ToggleButtonStyle.d.ts index b4117eeb1..b0df99d30 100644 --- a/components/lib/togglebutton/style/ToggleButtonStyle.d.ts +++ b/components/lib/togglebutton/style/ToggleButtonStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * ToggleButton is used to select a boolean value using a button. + * + * [Live Demo](https://www.primevue.org/togglebutton/) + * + * @module togglebuttonstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ToggleButtonClasses { + root = 'p-togglebutton', + icon = 'p-togglebutton-icon', + label = 'p-togglebutton-label' +} + export interface ToggleButtonStyle extends BaseStyle {} diff --git a/components/lib/toggleswitch/style/ToggleSwitchStyle.d.ts b/components/lib/toggleswitch/style/ToggleSwitchStyle.d.ts index 57ba142a6..18495ac12 100644 --- a/components/lib/toggleswitch/style/ToggleSwitchStyle.d.ts +++ b/components/lib/toggleswitch/style/ToggleSwitchStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * ToggleSwitch is used to select a boolean value. + * + * [Live Demo](https://www.primevue.org/toggleswitch/) + * + * @module toggleswitchstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ToggleSwitchClasses { + root = 'p-toggleswitch', + input = 'p-toggleswitch-input', + slider = 'p-toggleswitch-slider' +} + export interface ToggleSwitchStyle extends BaseStyle {} diff --git a/components/lib/toolbar/style/ToolbarStyle.d.ts b/components/lib/toolbar/style/ToolbarStyle.d.ts index ec214266b..fe799ad4e 100644 --- a/components/lib/toolbar/style/ToolbarStyle.d.ts +++ b/components/lib/toolbar/style/ToolbarStyle.d.ts @@ -1,3 +1,19 @@ +/** + * + * Toolbar is a grouping component for buttons and other content. + * + * [Live Demo](https://www.primevue.org/toolbar/) + * + * @module toolbarstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum ToolbarClasses { + root = 'p-toolbar', + start = 'p-toolbar-start', + center = 'p-toolbar-center', + end = 'p-toolbar-end' +} + export interface ToolbarStyle extends BaseStyle {} diff --git a/components/lib/tooltip/style/TooltipStyle.d.ts b/components/lib/tooltip/style/TooltipStyle.d.ts index a3ceef171..60e388825 100644 --- a/components/lib/tooltip/style/TooltipStyle.d.ts +++ b/components/lib/tooltip/style/TooltipStyle.d.ts @@ -1,3 +1,18 @@ +/** + * + * Tooltip directive provides advisory information for a component. + * + * [Live Demo](https://primevue.org/tooltip) + * + * @module tooltipstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TooltipClasses { + root = 'p-tooltip', + arrow = 'p-tooltip-arrow', + text = 'p-tooltip-text' +} + export interface TooltipStyle extends BaseStyle {} diff --git a/components/lib/tree/style/TreeStyle.d.ts b/components/lib/tree/style/TreeStyle.d.ts index 40b8b94a2..3eb06fedc 100644 --- a/components/lib/tree/style/TreeStyle.d.ts +++ b/components/lib/tree/style/TreeStyle.d.ts @@ -1,3 +1,30 @@ +/** + * + * Tree is used to display hierarchical data. + * + * [Live Demo](https://www.primevue.org/tree/) + * + * @module treestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TreeClasses { + root = 'p-tree', + mask = 'p-tree-mask', + loadingIcon = 'p-tree-loading-icon', + pcFilterInput = 'p-tree-filter-input', + wrapper = 'p-tree-root', + rootChildren = 'p-tree-root-children', + node = 'p-tree-node', + nodeContent = 'p-tree-node-content', + nodeToggleButton = 'p-tree-node-toggle-button', + nodeToggleIcon = 'p-tree-node-toggle-icon', + nodeTogglerIcon = 'p-tree-node-toggler-icon', + nodeCheckbox = 'p-tree-node-checkbox', + nodeIcon = 'p-tree-node-icon', + nodeLabel = 'p-tree-node-label', + nodeChildren = 'p-tree-node-children' +} + export interface TreeStyle extends BaseStyle {} diff --git a/components/lib/treeselect/style/TreeSelectStyle.d.ts b/components/lib/treeselect/style/TreeSelectStyle.d.ts index 75137c8cd..9f5d3c799 100644 --- a/components/lib/treeselect/style/TreeSelectStyle.d.ts +++ b/components/lib/treeselect/style/TreeSelectStyle.d.ts @@ -1,3 +1,25 @@ +/** + * + * TreeSelect is a form component to choose from hierarchical data. + * + * [Live Demo](https://www.primevue.org/treeselect/) + * + * @module treeselectstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TreeSelectClasses { + root = 'p-treeselect', + labelContainer = 'p-treeselect-label-container', + label = 'p-treeselect-label', + chip = 'p-treeselect-chip', + pcChipLabel = 'p-treeselect-chip-label', + dropdown = 'p-treeselect-dropdown', + dropdownIcon = 'p-treeselect-dropdown-icon', + panel = 'p-treeselect-overlay', + treeContainer = 'p-treeselect-tree-container', + emptyMessage = 'p-treeselect-empty-message' +} + export interface TreeSelectStyle extends BaseStyle {} diff --git a/components/lib/treetable/style/TreeTableStyle.d.ts b/components/lib/treetable/style/TreeTableStyle.d.ts index 1cb3534bd..e3ba7569c 100644 --- a/components/lib/treetable/style/TreeTableStyle.d.ts +++ b/components/lib/treetable/style/TreeTableStyle.d.ts @@ -1,3 +1,36 @@ +/** + * + * TreeTable is used to display hierarchical data in tabular format. + * + * [Live Demo](https://www.primevue.org/treetable/) + * + * @module treetablestyle + * + */ import { BaseStyle } from '../../base/style'; +export enum TreeTableClasses { + root = 'p-treetable', + loading = 'p-treetable-loading', + mask = 'p-treetable-mask', + loadingIcon = 'p-treetable-loading-icon', + header = 'p-treetable-header', + paginator = 'p-treetable-paginator-[position]', + tableContainer = 'p-treetable-table-container', + table = 'p-treetable-table', + thead = 'p-treetable-thead', + columnResizer = 'p-treetable-column-resizer', + columnTitle = 'p-treetable-column-title', + sortIcon = 'p-treetable-sort-icon', + sortBadge = 'p-treetable-sort-badge', + tbody = 'p-treetable-tbody', + nodeToggleButton = 'p-treetable-node-toggle-button', + nodeToggleIcon = 'p-treetable-node-toggle-icon', + pcNodeCheckbox = 'p-treetable-node-checkbox', + emptyMessage = 'p-treetable-empty-message', + tfoot = 'p-treetable-tfoot', + footer = 'p-treetable-footer', + columnResizeIndicator = 'p-treetable-column-resize-indicator' +} + export interface TreeTableStyle extends BaseStyle {} diff --git a/components/lib/virtualscroller/style/VirtualScrollerStyle.d.ts b/components/lib/virtualscroller/style/VirtualScrollerStyle.d.ts index fb0886fb5..a677d6e0f 100644 --- a/components/lib/virtualscroller/style/VirtualScrollerStyle.d.ts +++ b/components/lib/virtualscroller/style/VirtualScrollerStyle.d.ts @@ -1,3 +1,14 @@ +/** + * + * VirtualScroller is a performant approach to handle huge data efficiently. + * + * [Live Demo](https://www.primevue.org/virtualscroller/) + * + * @module virtualscrollerstyle + * + */ import { BaseStyle } from '../../base/style'; +export enum VirtualScrollerClasses {} + export interface VirtualScrollerStyle extends BaseStyle {} diff --git a/doc/badge/theming/StyledDoc.vue b/doc/badge/theming/StyledDoc.vue index 2c1a9c069..9dbeea1d2 100644 --- a/doc/badge/theming/StyledDoc.vue +++ b/doc/badge/theming/StyledDoc.vue @@ -33,7 +33,7 @@ p-badge-warn - Badge element with warning severity. + Badge element with warn severity. p-badge-danger diff --git a/doc/button/OutlinedDoc.vue b/doc/button/OutlinedDoc.vue index 5f96144f5..8872919ed 100644 --- a/doc/button/OutlinedDoc.vue +++ b/doc/button/OutlinedDoc.vue @@ -7,7 +7,7 @@