primevue Documentation

Technical Documentation: primefaces/primevue

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

PrimeVue

[!WARNING]
This repository is no longer under active development and receives security fixes only. PrimeVue continues as part of PrimeUI.
Issues here are read-only. Bug reports and feature requests belong at PrimeUI; for security vulnerabilities, see SECURITY.md.

The next chapter has begun. Copy Section

After years as an open source library, PrimeVue enters its next chapter as part of PrimeUI, a sustainable foundation for the libraries you rely on.

What this means Copy Chapter

Existing MIT versions remain MIT, forever.
Every release published under the MIT license stays exactly as it is. Your existing projects are unaffected. Nothing is taken away.

Security updates continue here.
We keep publishing security fixes for the MIT-licensed releases. How to report one is in SECURITY.md.

Development continues at a new home.
Active development, new releases, and everything ahead now live under PrimeUI.

➡️ Read the announcement: primeui.dev/nextchapter

➡️ The journey continues at: primevue.dev

Thank you Copy Chapter

To everyone who used PrimeVue, filed an issue, opened a pull request, answered a question, or simply built something with it, thank you. This library reached hundreds of millions of downloads because of you.

The next chapter is just beginning, and we hope you'll be part of it.

The PrimeTek Team

Overview (`packages/mcp/README.md`) Copy Section

@primevue/mcp

Model Context Protocol (MCP) server for PrimeVue component library. Provides AI assistants with comprehensive access to PrimeVue component documentation, props, events, slots, theming, and code examples.

What is MCP? Copy Chapter

Model Context Protocol (MCP) is an open standard that enables AI models to connect with external tools and data sources. By installing this MCP server, your AI assistant gains deep knowledge of PrimeVue components and can provide accurate, up-to-date information while helping you build Vue.js applications.

Installation Copy Chapter

Claude Code Copy Section

Add the PrimeVue MCP server using the CLI:

# Add to your user config (available in all projects)
claude mcp add primevue -s user -- npx -y @primevue/mcp

# Or add to current project only
claude mcp add primevue -- npx -y @primevue/mcp

Alternatively, use the JSON format for more control:

claude mcp add-json primevue '{"command":"npx","args":["-y","@primevue/mcp"]}' -s user

Useful commands:

claude mcp list           # List all MCP servers
claude mcp get primevue   # Get server details
claude mcp remove primevue # Remove the server

After adding, start a new Claude Code session and use /mcp to verify the connection.

Reference: Claude Code MCP Documentation

Cursor Copy Section

Option 1: Project Configuration

Create .cursor/mcp.json in your project:

{
    "mcpServers": {
        "primevue": {
            "command": "npx",
            "args": ["-y", "@primevue/mcp"]
        }
    }
}

Option 2: Global Configuration

Create or edit ~/.cursor/mcp.json in your home directory:

{
    "mcpServers": {
        "primevue": {
            "command": "npx",
            "args": ["-y", "@primevue/mcp"]
        }
    }
}

Option 3: Via Settings UI

1. Go to Cursor Settings > Tools & Integrations
2. Click New MCP Server
3. Add the configuration above

After adding, go to Settings > MCP and click the refresh button. The Composer Agent will automatically use PrimeVue tools when relevant.

Reference: Cursor MCP Documentation

VS Code (GitHub Copilot) Copy Section

Option 1: Project Configuration

Create .vscode/mcp.json in your project:

{
    "servers": {
        "primevue": {
            "command": "npx",
            "args": ["-y", "@primevue/mcp"]
        }
    }
}

Option 2: User Configuration (Global)

Create or edit the MCP configuration file in your VS Code user data directory:

• macOS: ~/Library/Application Support/Code/User/mcp.json
• Windows: %APPDATA%\Code\User\mcp.json
• Linux: ~/.config/Code/User/mcp.json

{
    "servers": {
        "primevue": {
            "command": "npx",
            "args": ["-y", "@primevue/mcp"]
        }
    }
}

Option 3: Via Command Palette

1. Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
2. Type "MCP: Add Server"
3. Select "Command (stdio)"
4. Enter primevue as the server ID
5. Enter npx as the command
6. Enter -y,@primevue/mcp as the arguments

After adding, use Copilot in Agent mode to access PrimeVue tools. The MCP server will be available in GitHub Copilot Chat.

Reference: VS Code MCP Documentation

OpenAI Codex CLI Copy Section

Option 1: Using the CLI

codex mcp add primevue -- npx -y @primevue/mcp

Option 2: Direct Configuration

Edit ~/.codex/config.toml:

[mcp_servers.primevue]
command = "npx"
args = ["-y", "@primevue/mcp"]

After adding, the MCP server will be available in both the Codex CLI and VS Code extension.

Reference: OpenAI Codex MCP Documentation

Windsurf Copy Section

Option 1: Via Settings UI

1. Click Windsurf - Settings (bottom right) or press Cmd+Shift+P / Ctrl+Shift+P
2. Type "Open Windsurf Settings"
3. Navigate to Cascade section
4. Click Manage MCPs > View raw config

Option 2: Direct Configuration

Edit ~/.codeium/windsurf/mcp_config.json:

{
    "mcpServers": {
        "primevue": {
            "command": "npx",
            "args": ["-y", "@primevue/mcp"]
        }
    }
}

After adding, the MCP server will be available in Cascade.

Reference: Windsurf MCP Documentation

Zed Copy Section

Add to your Zed settings (~/.config/zed/settings.json on Linux, ~/Library/Application Support/Zed/settings.json on macOS):

{
    "context_servers": {
        "primevue": {
            "command": {
                "path": "npx",
                "args": ["-y", "@primevue/mcp"]
            }
        }
    }
}

After adding, restart Zed. Check the Agent Panel's settings view - a green indicator dot next to "primevue" confirms the server is active.

Reference: Zed MCP Documentation

Available Tools Copy Chapter

Component Information Copy Section

Code Examples Copy Section

Theming & Styling Copy Section

Documentation & Guides Copy Section

Search & Discovery Copy Section

Utilities Copy Section

Vue Composables Copy Section

Example Prompts Copy Chapter

Once installed, try asking your AI assistant:

• "What are all the props available for the DataTable component?"
• "Show me how to implement row selection in DataTable"
• "How do I customize Button styles using Pass Through?"
• "What design tokens are available for the Card component?"
• "Find me a component for selecting multiple items from a list"
• "Compare AutoComplete and Select components"

Requirements Copy Chapter

• Node.js 18+
• One of the supported AI tools (Claude Code, VS Code + Copilot, Cursor, Windsurf, Claude Desktop)

Links Copy Chapter

• PrimeVue Documentation
• Model Context Protocol
• GitHub Repository
• Report Issues

License Copy Chapter

MIT

Overview (`packages/nuxt-module/README.md`) Copy Section

PrimeVue Nuxt Module

[

• ✨ Release Notes
• 📖 Documentation

Quick Setup Copy Chapter

1. Add @primevue/nuxt-module dependency to your project

npx nuxi@latest module add primevue

2. Add @primevue/nuxt-module to the modules section of nuxt.config.{ts,js}

{
    modules: ['@primevue/nuxt-module'];
}

That's it! You can now use @primevue/nuxt-module in your Nuxt app ✨

Overview (`packages/primevue/README.md`) Copy Section

PrimeVue Website

PrimeVue is a rich set of open source UI Components for Vue. Visit the PrimeVue website for interactive demos, comprehensive documentation and additional resources.

Apps Showcase Doc Common Apidoc Index.Json (`apps/showcase/doc/common/apidoc/index.json`) Copy Section

{
"form": {
"description": "Form provides validation functionality and manages form state.\n\nLive Demo",
"components": {
"default": {
"description": "Form provides validation functionality and manages form state.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"FormPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "FormProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"FormPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "FormProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "FormPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"FormPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"FormResolverOptions": {
"description": "Resolver options for Form component.",
"relatedProp": "",
"props": [
{
"name": "values",
"optional": false,
"readonly": false,
"type": "Record<string, any>",
"default": "",
"description": "The values of the form fields."
},
{
"name": "names",
"optional": false,
"readonly": false,
"type": "undefined | string[]",
"default": "",
"description": "The names of the form fields."
}
],
"methods": []
},
"FormSubmitEvent": {
"description": "Submit events",
"relatedProp": "",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "The original DOM event."
},
{
"name": "values",
"optional": false,
"readonly": false,
"type": "T",
"default": "",
"description": "The form values."
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "Record<string, FormFieldState>",
"default": "",
"description": "The form state."
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the form is valid."
},
{
"name": "errors",
"optional": false,
"readonly": false,
"type": "any[]",
"default": "",
"description": "The form errors."
},
{
"name": "reset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"FormResetEvent": {
"description": "Reset events",
"relatedProp": "",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "The original DOM event."
}
],
"methods": []
},
"FormFieldState": {
"description": "The state of a form field.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "The value of the form field."
},
{
"name": "touched",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the form field has been touched."
},
{
"name": "dirty",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the form field has been modified."
},
{
"name": "pristine",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether the form field has not been modified."
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether the form field is valid."
},
{
"name": "invalid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the form field is invalid."
},
{
"name": "error",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "The first error message of the form field."
},
{
"name": "errors",
"optional": false,
"readonly": false,
"type": "any[]",
"default": "[]",
"description": "All error messages of the form field."
}
],
"methods": [],
"extendedTypes": "useFormFieldState"
},
"FormProps": {
"description": "Defines valid properties in Form component.",
"relatedProp": "",
"props": [
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "initialValues",
"optional": true,
"readonly": false,
"type": "Record<string, any>",
"default": "",
"description": "The initial values for the form fields."
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "true",
"description": "Whether to validate the form fields when the values change."
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "false",
"description": "Whether to validate the form fields when they lose focus (on blur)."
},
{
"name": "validateOnMount",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "false",
"description": "Whether to validate the form fields immediately after the form is mounted."
},
{
"name": "validateOnSubmit",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "true",
"description": "Whether to validate the form fields when the form is submitted."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "PassThroughOptions",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"FormSlots": {
"description": "Defines valid slots in Form component.",
"relatedProp": "",
"props": [
{
"name": "default",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"FormEmitsOptions": {
"description": "Defines valid emits in Form component.",
"relatedProp": "",
"props": [
{
"name": "submit",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "reset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"FormInstance": {
"relatedProp": "",
"props": [
{
"name": "setFieldValue",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "getFieldState",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "validate",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "setValues",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "reset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "submit",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the form is valid."
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "Record<string, FormFieldState>",
"default": "",
"description": "The state of each form field, with the field name as the key and its state as the value."
}
],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"FormPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"FormPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"FormPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"FormResolverOptions": {
"description": "Resolver options for Form component.",
"props": []
},
"FormSubmitEvent": {
"description": "Submit events",
"props": []
},
"FormResetEvent": {
"description": "Reset events",
"props": []
},
"FormFieldState": {
"description": "The state of a form field.",
"props": []
},
"FormProps": {
"description": "Defines valid properties in Form component.",
"props": []
},
"FormSlots": {
"description": "Defines valid slots in Form component.",
"props": []
},
"FormEmitsOptions": {
"description": "Defines valid emits in Form component.",
"props": []
},
"FormInstance": {
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"FormPassThroughOptionType": {
"values": "FormPassThroughAttributes | (options: FormPassThroughMethodOptions) => undefined | string | null | undefined"
},
"FormEmits": {
"values": "EmitFn"
}
}
}
},
"formstyle": {
"description": "Live Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"FormStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"FormStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"FormClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-form"",
"description": "The class of root element"
}
]
}
}
}
},
"formfield": {
"description": "FormField is a helper component that provides validation and tracking for form fields.\n\nLive Demo",
"components": {
"default": {
"description": "FormField is a helper component that provides validation and tracking for form fields.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"FormFieldPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "FormFieldProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"FormFieldPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "FormFieldProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "FormFieldPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"FormFieldPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"FormFieldResolverOptions": {
"description": "Resolver options for FormField component.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "The value of the form field."
},
{
"name": "name",
"optional": false,
"readonly": false,
"type": "undefined | string",
"default": "",
"description": "The name of the form field."
}
],
"methods": []
},
"FormFieldProps": {
"description": "Defines valid properties in FormField component.",
"relatedProp": "",
"props": [
{
"name": "name",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "The name of the form field."
},
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "initialValue",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "The initial value for the form field."
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether to validate the form field when the value change."
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether to validate the form field when it loses focus (on blur)."
},
{
"name": "validateOnMount",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether to validate the form field immediately after the form is mounted."
},
{
"name": "validateOnSubmit",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether to validate the form field when the form is submitted."
},
{
"name": "as",
"optional": true,
"readonly": false,
"type": "string | Component",
"default": "DIV",
"description": "Use to change the HTML tag of root element."
},
{
"name": "asChild",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it changes the default rendered element for the one passed as a child element."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "PassThroughOptions",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"FormFieldSlots": {
"description": "Defines valid slots in FormField component.",
"relatedProp": "",
"props": [
{
"name": "default",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"FormFieldEmitsOptions": {
"description": "Defines valid emits in FormField component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"FormFieldPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"FormFieldPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"FormFieldPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"FormFieldResolverOptions": {
"description": "Resolver options for FormField component.",
"props": []
},
"FormFieldProps": {
"description": "Defines valid properties in FormField component.",
"props": []
},
"FormFieldSlots": {
"description": "Defines valid slots in FormField component.",
"props": []
},
"FormFieldEmitsOptions": {
"description": "Defines valid emits in FormField component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"FormFieldPassThroughOptionType": {
"values": "FormFieldPassThroughAttributes | (options: FormFieldPassThroughMethodOptions) => undefined | string | null | undefined"
},
"FormFieldEmits": {
"values": "EmitFn"
}
}
}
},
"formfieldstyle": {
"description": "Live Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"FormFieldStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"FormFieldStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"FormFieldClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-formfield"",
"description": "The class of root element"
}
]
}
}
}
},
"forms/src": {},
"forms/src/resolvers/joi": {},
"forms/src/resolvers/superstruct": {},
"forms/src/resolvers/valibot": {},
"forms/src/resolvers/yup": {},
"forms/src/resolvers/zod": {},
"forms/src/types": {
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"PassThroughOptions": {
"relatedProp": "",
"props": [
{
"name": "mergeSections",
"optional": true,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "mergeProps",
"optional": true,
"readonly": false,
"type": "PassThroughMergePropsType",
"default": ""
}
],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"PassThroughOptions": {
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"PassThroughMergePropsType": {
"values": "(args: any) => undefined | boolean | undefined",
"description": "From primevue/passthrough/index.d.ts"
}
}
}
},
"forms/src/useform": {
"functions": {
"description": "Defines the custom functions used by the module.",
"values": {
"useForm": {
"name": "useForm",
"parameters": [
{
"name": "options",
"type": "useFormOptions"
}
],
"returnType": "useFormReturn"
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"useFormFieldState": {
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "touched",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "dirty",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "pristine",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "invalid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "error",
"optional": false,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "errors",
"optional": false,
"readonly": false,
"type": "any[]",
"default": ""
}
],
"methods": [],
"extendedBy": "FormFieldState"
},
"useFormFieldOptions": {
"relatedProp": "",
"props": [
{
"name": "initialValue",
"optional": true,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "props",
"optional": true,
"readonly": false,
"type": "Record<string, any> | Function",
"default": ""
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBlur",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInput",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onChange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInvalid",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"useFormFieldProps": {
"relatedProp": "",
"props": [
{
"name": "name",
"optional": false,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "onBlur",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInput",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onChange",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInvalid",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"useFormFieldInstance": {
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "useFormFieldProps",
"default": ""
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "useFormFieldState",
"default": ""
},
{
"name": "options",
"optional": true,
"readonly": false,
"type": "useFormFieldOptions",
"default": ""
},
{
"name": "_watcher",
"optional": false,
"readonly": false,
"type": "Object",
"default": ""
}
],
"methods": []
},
"useFormReturn": {
"relatedProp": "",
"props": [
{
"name": "defineField",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "setFieldValue",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "getFieldState",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "handleSubmit",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "handleReset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "validate",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "setValues",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "reset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "Record<string, useFormFieldState>",
"default": ""
},
{
"name": "fields",
"optional": false,
"readonly": false,
"type": "Record<string, useFormFieldInstance>",
"default": ""
}
],
"methods": []
},
"useFormResolverOptions": {
"relatedProp": "",
"props": [
{
"name": "values",
"optional": false,
"readonly": false,
"type": "Record<string, any>",
"default": ""
},
{
"name": "names",
"optional": false,
"readonly": false,
"type": "undefined | string[]",
"default": ""
}
],
"methods": []
},
"useFormOptions": {
"relatedProp": "",
"props": [
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "initialValues",
"optional": true,
"readonly": false,
"type": "Record<string, any>",
"default": ""
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnMount",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnSubmit",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
}
],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"useFormFieldState": {
"props": []
},
"useFormFieldOptions": {
"props": []
},
"useFormFieldProps": {
"props": []
},
"useFormFieldInstance": {
"props": []
},
"useFormReturn": {
"props": []
},
"useFormResolverOptions": {
"props": []
},
"useFormOptions": {
"props": []
}
}
}
},
"accordion": {
"description": "Accordion groups a collection of contents in tabs.\n\nLive Demo",
"components": {
"default": {
"description": "Accordion groups a collection of contents in tabs.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AccordionProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "AccordionState",
"default": "",
"description": "Defines current inline state."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AccordionTabOpenEvent": {
"description": "Custom tab open event.",
"relatedProp": "AccordionEmitsOptions.tab-open",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "MouseEvent",
"default": "",
"description": "Browser mouse event."
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Opened tab index."
}
],
"methods": [],
"extendedBy": "AccordionTabCloseEvent,AccordionClickEvent"
},
"AccordionTabCloseEvent": {
"description": "Custom tab close event.",
"relatedProp": "AccordionEmitsOptions.tab-close",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "MouseEvent",
"default": "",
"description": "Browser mouse event."
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Opened tab index."
}
],
"methods": [],
"extendedTypes": "AccordionTabOpenEvent"
},
"AccordionClickEvent": {
"description": "Custom tab open event.",
"relatedProp": "AccordionEmitsOptions.tab-open",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "MouseEvent",
"default": "",
"description": "Browser mouse event."
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Opened tab index."
}
],
"methods": [],
"extendedTypes": "AccordionTabOpenEvent"
},
"AccordionPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AccordionProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AccordionPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AccordionPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionState": {
"description": "Defines current inline state in Accordion component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current id state as a string"
},
{
"name": "d_value",
"optional": false,
"readonly": false,
"type": "string | string[]",
"default": "",
"description": "Current active value state."
}
],
"methods": []
},
"AccordionProps": {
"description": "Defines valid properties in Accordion component.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": true,
"readonly": false,
"type": "null | string | number | string[] | number[]",
"default": "null",
"description": "Value of the active panel or an array of values in multiple mode."
},
{
"name": "multiple",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, multiple tabs can be activated at the same time."
},
{
"name": "activeIndex",
"optional": true,
"readonly": false,
"type": "null | number | number[]",
"default": "null",
"description": "Index of the active tab or an array of indexes in multiple mode.",
"deprecated": "since v4. Use value property instead."
},
{
"name": "lazy",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, hidden tabs are not rendered at all. Defaults to false that hides tabs with css."
},
{
"name": "expandIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon of a collapsed tab."
},
{
"name": "collapseIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon of an expanded tab."
},
{
"name": "tabindex",
"optional": true,
"readonly": false,
"type": "number",
"default": "0",
"description": "Index of the element in tabbing order."
},
{
"name": "selectOnFocus",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, the focused tab is activated."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"AccordionSlots": {
"description": "Defines valid slots in Accordion slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Default slot to detect AccordionTab components."
},
{
"name": "collapseicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom collapse icon template."
},
{
"name": "expandicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom expand icon template."
}
]
},
"AccordionEmitsOptions": {
"description": "Defines valid emits in Accordion component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "update:value",
"parameters": [
{
"name": "value",
"optional": false,
"type": "undefined | null | string | string[]",
"description": "Value of new active panel."
}
],
"returnType": "void",
"description": "Emitted when the active panel changes."
},
{
"name": "update:activeIndex",
"parameters": [
{
"name": "value",
"optional": false,
"type": "undefined | number",
"description": "Index of new active tab."
}
],
"returnType": "void",
"description": "Emitted when the active tab changes.",
"deprecated": "since v4. Use update:value emit instead."
},
{
"name": "tab-open",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AccordionTabOpenEvent",
"description": "Custom tab open event."
}
],
"returnType": "void",
"description": "Callback to invoke when a tab gets expanded.",
"deprecated": "since v4."
},
{
"name": "tab-close",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AccordionTabCloseEvent",
"description": "Custom tab close event."
}
],
"returnType": "void",
"description": "Callback to invoke when an active tab is collapsed by clicking on the header.",
"deprecated": "since v4."
},
{
"name": "tab-click",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AccordionClickEvent",
"description": "Custom tab click event."
}
],
"returnType": "void",
"description": "Callback to invoke when an active tab is clicked.",
"deprecated": "since v4."
}
]
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AccordionTabOpenEvent": {
"description": "Custom tab open event.",
"props": []
},
"AccordionTabCloseEvent": {
"description": "Custom tab close event.",
"props": []
},
"AccordionClickEvent": {
"description": "Custom tab open event.",
"props": []
},
"AccordionPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AccordionPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"AccordionState": {
"description": "Defines current inline state in Accordion component.",
"props": []
},
"AccordionProps": {
"description": "Defines valid properties in Accordion component.",
"props": []
},
"AccordionSlots": {
"description": "Defines valid slots in Accordion slots.",
"props": []
},
"AccordionEmitsOptions": {
"description": "Defines valid emits in Accordion component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AccordionPassThroughOptionType": {
"values": "AccordionPassThroughAttributes | (options: AccordionPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AccordionEmits": {
"values": "EmitFn"
}
}
}
},
"accordionstyle": {
"description": "Accordion groups a collection of contents in tabs.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AccordionClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-accordion"",
"description": "Class name of the root element"
}
]
}
}
}
},
"accordioncontent": {
"description": "AccordionContent is a helper component for Accordion component.\n\nLive Demo",
"components": {
"default": {
"description": "AccordionContent is a helper component for Accordion component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionContentPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AccordionContentProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "AccordionContentContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AccordionContentPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AccordionContentProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AccordionContentPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "transition",
"optional": true,
"readonly": false,
"type": "AccordionContentPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the transition's DOM element."
},
{
"name": "contentWrapper",
"optional": true,
"readonly": false,
"type": "AccordionContentPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content's wrapper DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "AccordionContentPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AccordionContentPassThroughAttributes": {
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionContentProps": {
"description": "Defines valid properties in AccordionContent component.",
"relatedProp": "",
"props": [
{
"name": "as",
"optional": true,
"readonly": false,
"type": "string | Component",
"default": "DIV",
"description": "Use to change the HTML tag of root element."
},
{
"name": "asChild",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it changes the default rendered element for the one passed as a child element."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
}
],
"methods": []
},
"AccordionContentContext": {
"description": "Defines current options in AccordionContent component.",
"relatedProp": "",
"props": [
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the item is active."
}
],
"methods": []
},
"AccordionContentSlots": {
"description": "Defines valid slots in AccordionContent slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
}
]
},
"AccordionContentEmitsOptions": {
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionContentPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AccordionContentPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AccordionContentPassThroughAttributes": {
"props": []
},
"AccordionContentProps": {
"description": "Defines valid properties in AccordionContent component.",
"props": []
},
"AccordionContentContext": {
"description": "Defines current options in AccordionContent component.",
"props": []
},
"AccordionContentSlots": {
"description": "Defines valid slots in AccordionContent slots.",
"props": []
},
"AccordionContentEmitsOptions": {
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AccordionContentPassThroughOptionType": {
"values": "AccordionContentPassThroughAttributes | (options: AccordionContentPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AccordionContentEmits": {
"values": "EmitFn"
}
}
}
},
"accordioncontentstyle": {
"description": "AccordionContent is a helper component for Accordion component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionContentStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionContentStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AccordionContentClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-accordioncontent"",
"description": "Class name of the root element"
},
{
"name": "content",
"optional": false,
"readonly": false,
"value": ""p-accordioncontent-content"",
"description": "Class name of the content element"
}
]
}
}
}
},
"accordionheader": {
"description": "AccordionHeader is a helper component for Accordion component.\n\nLive Demo",
"components": {
"default": {
"description": "AccordionHeader is a helper component for Accordion component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionHeaderPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AccordionHeaderProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "AccordionHeaderContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AccordionHeaderPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AccordionHeaderProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AccordionHeaderPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "toggleicon",
"optional": true,
"readonly": false,
"type": "AccordionHeaderPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AccordionHeaderPassThroughAttributes": {
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionHeaderProps": {
"description": "Defines valid properties in AccordionHeader component.",
"relatedProp": "",
"props": [
{
"name": "as",
"optional": true,
"readonly": false,
"type": "string | Component",
"default": "BUTTON",
"description": "Use to change the HTML tag of root element."
},
{
"name": "asChild",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it changes the default rendered element for the one passed as a child element."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
}
],
"methods": []
},
"AccordionHeaderContext": {
"description": "Defines current options in AccordionHeader component.",
"relatedProp": "",
"props": [
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the item is active."
}
],
"methods": []
},
"AccordionHeaderSlots": {
"description": "Defines valid slots in AccordionHeader slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t active: boolean, // Whether the item is active.\n }"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
},
{
"name": "toggleicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom toggleicon template."
}
]
},
"AccordionHeaderEmitsOptions": {
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionHeaderPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AccordionHeaderPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AccordionHeaderPassThroughAttributes": {
"props": []
},
"AccordionHeaderProps": {
"description": "Defines valid properties in AccordionHeader component.",
"props": []
},
"AccordionHeaderContext": {
"description": "Defines current options in AccordionHeader component.",
"props": []
},
"AccordionHeaderSlots": {
"description": "Defines valid slots in AccordionHeader slots.",
"props": []
},
"AccordionHeaderEmitsOptions": {
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AccordionHeaderPassThroughOptionType": {
"values": "AccordionHeaderPassThroughAttributes | (options: AccordionHeaderPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AccordionHeaderEmits": {
"values": "EmitFn"
}
}
}
},
"accordionheaderstyle": {
"description": "AccordionHeader is a helper component for Accordion component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionHeaderStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionHeaderStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AccordionHeaderClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-accordionheader"",
"description": "Class name of the root element"
},
{
"name": "toggleicon",
"optional": false,
"readonly": false,
"value": ""p-accordionheader-toggle-icon"",
"description": "Class name of the toggleicon element"
}
]
}
}
}
},
"accordionpanel": {
"description": "AccordionPanel is a helper component for Accordion component.\n\nLive Demo",
"components": {
"default": {
"description": "AccordionPanel is a helper component for Accordion component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionPanelPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AccordionPanelProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "AccordionPanelContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AccordionPanelPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AccordionPanelProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AccordionPanelPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AccordionPanelPassThroughAttributes": {
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionPanelProps": {
"description": "Defines valid properties in AccordionPanel component.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "undefined | string | number",
"default": "",
"description": "Unique value of item."
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the item is disabled."
},
{
"name": "as",
"optional": true,
"readonly": false,
"type": "string | Component",
"default": "DIV",
"description": "Use to change the HTML tag of root element."
},
{
"name": "asChild",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it changes the default rendered element for the one passed as a child element."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
}
],
"methods": []
},
"AccordionPanelContext": {
"description": "Defines current options in AccordionPanel component.",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionPanelSlots": {
"description": "Defines valid slots in AccordionPanel slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
}
]
},
"AccordionPanelEmitsOptions": {
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionPanelPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AccordionPanelPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AccordionPanelPassThroughAttributes": {
"props": []
},
"AccordionPanelProps": {
"description": "Defines valid properties in AccordionPanel component.",
"props": []
},
"AccordionPanelContext": {
"description": "Defines current options in AccordionPanel component.",
"props": []
},
"AccordionPanelSlots": {
"description": "Defines valid slots in AccordionPanel slots.",
"props": []
},
"AccordionPanelEmitsOptions": {
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AccordionPanelPassThroughOptionType": {
"values": "AccordionPanelPassThroughAttributes | (options: AccordionPanelPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AccordionPanelEmits": {
"values": "EmitFn"
}
}
}
},
"accordionpanelstyle": {
"description": "AccordionPanel is a helper component for Accordion component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionPanelStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionPanelStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AccordionPanelClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-accordionpanel"",
"description": "Class name of the root element"
}
]
}
}
}
},
"accordiontab": {
"description": "",
"components": {
"default": {
"description": "",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionTabPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AccordionTabProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "AccordionTabContext",
"default": "",
"description": "Defines current options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AccordionTabPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AccordionTabProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "header",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the header's DOM element."
},
{
"name": "headerAction",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the headeraction's DOM element."
},
{
"name": "headerIcon",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the headericon's DOM element."
},
{
"name": "headerTitle",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the headertitle's DOM element."
},
{
"name": "toggleableContent",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the toggleablecontent's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content's DOM element."
},
{
"name": "transition",
"optional": true,
"readonly": false,
"type": "AccordionTabPassThroughTransitionType",
"default": "",
"description": "Used to control Vue Transition API."
}
],
"methods": []
},
"AccordionTabPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AccordionTabProps": {
"description": "Defines valid properties in AccordionTab component.",
"relatedProp": "",
"props": [
{
"name": "header",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Orientation of tab headers."
},
{
"name": "headerStyle",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Inline style of the tab header."
},
{
"name": "headerClass",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the tab header."
},
{
"name": "headerProps",
"optional": true,
"readonly": false,
"type": "HTMLAttributes",
"default": "",
"description": "Used to pass all properties of the HTMLDivElement to the tab header."
},
{
"name": "headerActionProps",
"optional": true,
"readonly": false,
"type": "AnchorHTMLAttributes",
"default": "",
"description": "Used to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header."
},
{
"name": "contentStyle",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Inline style of the tab content."
},
{
"name": "contentClass",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the tab content."
},
{
"name": "contentProps",
"optional": true,
"readonly": false,
"type": "HTMLAttributes",
"default": "",
"description": "Used to pass all properties of the HTMLDivElement to the tab content."
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the tab is disabled."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
}
],
"methods": []
},
"AccordionTabContext": {
"description": "Defines current options in AccordionTab component.",
"relatedProp": "",
"props": [
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Current index of the tab."
},
{
"name": "count",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Count of tabs"
},
{
"name": "first",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the tab is first."
},
{
"name": "last",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the tab is last."
},
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Whether the tab is active."
}
],
"methods": []
},
"AccordionTabSlots": {
"description": "Defines valid slots in AcordionTab slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Default slot for content."
},
{
"name": "header",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content for the title section of a AccordionTab is defined using the header template."
},
{
"name": "headericon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t index: number, // Index of the tab\n \t active: (index: number) ⇒ void, // Whether the tab is active\n}",
"description": "header slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom icon for the header section of a AccordionTab is defined using the headericon template."
}
]
},
"AccordionTabEmitsOptions": {
"description": "Defines valid emits in AcordionTab component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionTabPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AccordionTabPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AccordionTabPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"AccordionTabProps": {
"description": "Defines valid properties in AccordionTab component.",
"props": []
},
"AccordionTabContext": {
"description": "Defines current options in AccordionTab component.",
"props": []
},
"AccordionTabSlots": {
"description": "Defines valid slots in AcordionTab slots.",
"props": []
},
"AccordionTabEmitsOptions": {
"description": "Defines valid emits in AcordionTab component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AccordionTabPassThroughOptionType": {
"values": "AccordionTabPassThroughAttributes | (options: AccordionTabPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AccordionTabPassThroughTransitionType": {
"values": "TransitionProps | (options: AccordionTabPassThroughMethodOptions) => TransitionProps | undefined"
},
"AccordionTabEmits": {
"values": "EmitFn"
}
}
}
},
"accordiontabstyle": {
"description": "",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AccordionTabStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AccordionTabStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AccordionTabClasses": {
"members": []
}
}
}
},
"animateonscroll": {
"description": "AnimateOnScroll manages CSS classes declaratively to during enter/leave animations on scroll or on page load.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AnimateOnScrollOptions": {
"description": "Defines options of AnimateOnScroll.",
"relatedProp": "",
"props": [
{
"name": "enterClass",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Style class to add when item goes into viewport, use white space as a delimeter to define multiple classes."
},
{
"name": "leaveClass",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Style class to add when item leaves the viewport, use white space as a delimeter to define multiple classes."
},
{
"name": "root",
"optional": true,
"readonly": false,
"type": "null | Element | Document",
"default": "",
"description": "Specifies the root option of the IntersectionObserver API"
},
{
"name": "rootMargin",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Specifies the rootMargin option of the IntersectionObserver API"
},
{
"name": "threshold",
"optional": true,
"readonly": false,
"type": "readonly number[]",
"default": "",
"description": "Specifies the threshold option of the IntersectionObserver API"
}
],
"methods": []
},
"AnimateOnScrollDirectivePassThroughOptions": {
"description": "Custom passthrough(pt) directive options.",
"relatedProp": "",
"props": [
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AnimateOnScrollDirectiveModifiers": {
"description": "Defines modifiers of AnimateOnScroll.",
"relatedProp": "",
"props": [
{
"name": "once",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether the scroll event listener should be removed after initial run."
}
],
"methods": []
},
"AnimateOnScrollDirectiveBinding": {
"description": "Binding of AnimateOnScroll directive.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "null | ComponentPublicInstance<Object, Object, Object, Object, Object, Object, Object, Object, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, Object, Object, string, Object, Object, Object, string, ComponentProvideOptions>, Object, Object, "", Object, any> | Record<string, any>",
"default": ""
},
{
"name": "oldValue",
"optional": false,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "arg",
"optional": true,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "dir",
"optional": false,
"readonly": false,
"type": "ObjectDirective<any, any, string, any>",
"default": ""
},
{
"name": "value",
"optional": true,
"readonly": false,
"type": "AnimateOnScrollOptions",
"default": "",
"description": "Value of the AnimateOnScroll."
},
{
"name": "modifiers",
"optional": true,
"readonly": false,
"type": "AnimateOnScrollDirectiveModifiers",
"default": "",
"description": "Modifiers of the AnimateOnScroll."
}
],
"methods": [],
"extendedTypes": "Omit<DirectiveBinding, "modifiers" | "value">"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AnimateOnScrollOptions": {
"description": "Defines options of AnimateOnScroll.",
"props": []
},
"AnimateOnScrollDirectivePassThroughOptions": {
"description": "Custom passthrough(pt) directive options.",
"props": []
},
"AnimateOnScrollDirectiveModifiers": {
"description": "Defines modifiers of AnimateOnScroll.",
"props": []
},
"AnimateOnScrollDirectiveBinding": {
"description": "Binding of AnimateOnScroll directive.",
"props": []
}
}
}
},
"animateonscrollstyle": {
"description": "AnimateOnScroll manages CSS classes declaratively to during enter/leave animations on scroll or on page load.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AnimateOnScrollStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AnimateOnScrollStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AnimateOnScrollClasses": {
"members": []
}
}
}
},
"autocomplete": {
"description": "AutoComplete is an input component that provides real-time suggestions while being typed.\n\nLive Demo",
"components": {
"default": {
"description": "AutoComplete is an input component that provides real-time suggestions while being typed.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AutoCompletePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AutoCompleteProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "AutoCompleteState",
"default": "",
"description": "Defines current inline state."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "AutoCompleteContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AutoCompleteSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AutoCompleteProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "AutoCompleteState",
"default": "",
"description": "Defines current inline state."
}
],
"methods": []
},
"AutoCompleteChangeEvent": {
"description": "Custom change event.",
"relatedProp": "AutoCompleteEmitsOptions.change",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "Browser event."
},
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Selected option value"
}
],
"methods": []
},
"AutoCompleteOptionSelectEvent": {
"description": "Custom item select event.",
"relatedProp": "AutoCompleteEmitsOptions['item-select']",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "Browser event"
},
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Selected item"
}
],
"methods": [],
"extendedBy": "AutoCompleteOptionUnselectEvent"
},
"AutoCompleteOptionUnselectEvent": {
"description": "Custom item unselect event.",
"relatedProp": "AutoCompleteEmitsOptions['item-unselect']",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "Browser event"
},
{
"name": "value",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Selected item"
}
],
"methods": [],
"extendedTypes": "AutoCompleteOptionSelectEvent"
},
"AutoCompleteDropdownClickEvent": {
"description": "Custom dropdown click event.",
"relatedProp": "AutoCompleteEmitsOptions['dropdown-click']",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "MouseEvent",
"default": "",
"description": "Browser mouse event"
},
{
"name": "query",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current value of the input field"
}
],
"methods": []
},
"AutoCompleteCompleteEvent": {
"description": "Custom complete event.",
"relatedProp": "AutoCompleteEmitsOptions.complete",
"props": [
{
"name": "originalEvent",
"optional": false,
"readonly": false,
"type": "Event",
"default": "",
"description": "Browser event"
},
{
"name": "query",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Value to search with"
}
],
"methods": []
},
"AutoCompletePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AutoCompleteProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "pcInputText",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to pass attributes to the InputText component."
},
{
"name": "inputMultiple",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the input multiple's DOM element."
},
{
"name": "chipItem",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the chip's DOM element."
},
{
"name": "pcChip",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to pass attributes to the Chip."
},
{
"name": "chipIcon",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the chip icon's DOM element."
},
{
"name": "input",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the input chip's DOM element."
},
{
"name": "inputChip",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the input chip's DOM element."
},
{
"name": "loader",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the loader's DOM element."
},
{
"name": "clearIcon",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the clear icon's DOM element."
},
{
"name": "dropdown",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the dropdown's DOM element."
},
{
"name": "dropdownIcon",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the dropdown icon's DOM element."
},
{
"name": "overlay",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the overlay's DOM element."
},
{
"name": "virtualScroller",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to pass attributes to the VirtualScroller component."
},
{
"name": "listContainer",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the list container's DOM element."
},
{
"name": "list",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the list's DOM element."
},
{
"name": "optionGroup",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the option group's DOM element."
},
{
"name": "option",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the option's DOM element."
},
{
"name": "emptyMessage",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the empty message's DOM element."
},
{
"name": "searchResultMessage",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the search result message's DOM element."
},
{
"name": "selectedMessage",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the selected message's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
},
{
"name": "transition",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughTransitionType",
"default": "",
"description": "Used to control Vue Transition API."
}
],
"methods": []
},
"AutoCompletePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AutoCompleteState": {
"description": "Defines current inline state in AutoComplete component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current id state as a string."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focused state as a boolean."
},
{
"name": "focusedOptionIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "-1",
"description": "Current focused item index as a number."
},
{
"name": "focusedMultipleOptionIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "-1",
"description": "Current focused item index as a number."
},
{
"name": "overlayVisible",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current overlay visible state as a boolean."
},
{
"name": "searching",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current search state as a boolean."
},
{
"name": "multipleInputValue",
"optional": false,
"readonly": false,
"type": "Nullable",
"default": "null",
"description": "Value of the token input as a string."
}
],
"methods": []
},
"AutoCompleteContext": {
"description": "Defines current options in AutoComplete component.",
"relatedProp": "",
"props": [
{
"name": "option",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Current option."
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Index of the current option."
},
{
"name": "selected",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current selection state of the item as a boolean."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focus state of the item as a boolean."
},
{
"name": "disabled",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current disabled state of the item as a boolean."
}
],
"methods": []
},
"AutoCompleteProps": {
"description": "Defines valid properties in AutoComplete component.",
"relatedProp": "",
"props": [
{
"name": "modelValue",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Value of the component."
},
{
"name": "defaultValue",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "The default value for the input when not controlled by modelValue ."
},
{
"name": "name",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "The name attribute for the element, typically used in form submissions."
},
{
"name": "suggestions",
"optional": true,
"readonly": false,
"type": "any[]",
"default": "",
"description": "An array of suggestions to display."
},
{
"name": "optionLabel",
"optional": true,
"readonly": false,
"type": "string | Function",
"default": "",
"description": "Property name or getter function to use as the label of an option."
},
{
"name": "optionDisabled",
"optional": true,
"readonly": false,
"type": "string | Function",
"default": "",
"description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined."
},
{
"name": "optionGroupLabel",
"optional": true,
"readonly": false,
"type": "string | Function",
"default": "",
"description": "Property name or getter function to use as the label of an option group."
},
{
"name": "optionGroupChildren",
"optional": true,
"readonly": false,
"type": "string | Function",
"default": "",
"description": "Property name or getter function that refers to the children options of option group."
},
{
"name": "typeahead",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "whether typeahead is active or not."
},
{
"name": "scrollHeight",
"optional": true,
"readonly": false,
"type": "string",
"default": "14rem",
"description": "Maximum height of the suggestions overlay."
},
{
"name": "dropdown",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Displays a button next to the input field when enabled."
},
{
"name": "dropdownMode",
"optional": true,
"readonly": false,
"type": "HintedString<"blank" | "current">",
"default": "blank",
"description": "Specifies the behavior dropdown button. Default 'blank' mode sends an empty string and 'current' mode sends the input value."
},
{
"name": "multiple",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Specifies if multiple values can be selected."
},
{
"name": "showClear",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, a clear icon is displayed to clear the value."
},
{
"name": "placeholder",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Default text to display when no option is selected."
},
{
"name": "loading",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the autocomplete is in loading state."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "HintedString<"small" | "large">",
"default": "",
"description": "Defines the size of the component."
},
{
"name": "invalid",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should have invalid state style."
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should be disabled."
},
{
"name": "variant",
"optional": true,
"readonly": false,
"type": "null | HintedString<"outlined" | "filled">",
"default": "null",
"description": "Specifies the input variant of the component."
},
{
"name": "dataKey",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "A property to uniquely identify an option."
},
{
"name": "minLength",
"optional": true,
"readonly": false,
"type": "number",
"default": "1",
"description": "Minimum number of characters to initiate a search."
},
{
"name": "delay",
"optional": true,
"readonly": false,
"type": "number",
"default": "300",
"description": "Delay between keystrokes to wait before sending a query."
},
{
"name": "appendTo",
"optional": true,
"readonly": false,
"type": "HTMLElement | HintedString<"body" | "self">",
"default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached.\nSpecial keywords are 'body' for document body and 'self' for the element itself."
},
{
"name": "forceSelection",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, autocomplete clears the manual input if it does not match of the suggestions to force only accepting values from the suggestions."
},
{
"name": "completeOnFocus",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether to run a query when input receives focus."
},
{
"name": "inputId",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifier of the underlying input element."
},
{
"name": "inputStyle",
"optional": true,
"readonly": false,
"type": "object",
"default": "",
"description": "Inline style of the input field."
},
{
"name": "inputClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the input field."
},
{
"name": "panelStyle",
"optional": true,
"readonly": false,
"type": "object",
"default": "",
"description": "Inline style of the overlay."
},
{
"name": "panelClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the overlay."
},
{
"name": "overlayStyle",
"optional": true,
"readonly": false,
"type": "object",
"default": "",
"description": "Inline style of the overlay overlay."
},
{
"name": "overlayClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the overlay overlay."
},
{
"name": "dropdownIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in the dropdown."
},
{
"name": "dropdownClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the dropdown button."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in loading state.",
"deprecated": "since v4.0. Use 'loader' slot."
},
{
"name": "loader",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in loading state."
},
{
"name": "removeTokenIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in chip remove action."
},
{
"name": "chipIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in chip remove action."
},
{
"name": "virtualScrollerOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it."
},
{
"name": "autoOptionFocus",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether to focus on the first visible or selected element when the overlay is shown."
},
{
"name": "selectOnFocus",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, the focused option is selected."
},
{
"name": "focusOnHover",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "When enabled, the focus is placed on the hovered option."
},
{
"name": "searchLocale",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Locale to use in searching. The default locale is the host environment's current locale."
},
{
"name": "searchMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "'{0} results are available'",
"description": "Text to be displayed in hidden accessible field when filtering returns any results. Defaults to value from PrimeVue locale configuration."
},
{
"name": "selectionMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "'{0} items selected'",
"description": "Text to be displayed in hidden accessible field when options are selected. Defaults to value from PrimeVue locale configuration."
},
{
"name": "emptySelectionMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "No selected item",
"description": "Text to be displayed in hidden accessible field when any option is not selected. Defaults to value from PrimeVue locale configuration."
},
{
"name": "emptySearchMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "No results found",
"description": "Text to display when filtering does not return any results. Defaults to value from PrimeVue locale configuration."
},
{
"name": "showEmptyMessage",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "When enabled, empty search message will be visible."
},
{
"name": "tabindex",
"optional": true,
"readonly": false,
"type": "string | number",
"default": "",
"description": "Index of the element in tabbing order."
},
{
"name": "fluid",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "null",
"description": "Spans 100% width of the container when enabled."
},
{
"name": "ariaLabel",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines a string value that labels an interactive element."
},
{
"name": "ariaLabelledby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifier of the underlying input element."
},
{
"name": "formControl",
"optional": true,
"readonly": false,
"type": "Record<string, any>",
"default": "",
"description": "Form control object, typically used for handling validation and form state."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"AutoCompleteSlots": {
"description": "Defines valid slots in AutoComplete component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "chip",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t value: any, // A value in the selection\n \t index: number, // Index of the token.\n \t removeCallback: (event: Event) ⇒ void, // Remove token icon function.\n}",
"description": "chip slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom chip template."
},
{
"name": "header",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t value: any, // Value of the component\n \t suggestions: any, // Displayed options\n }",
"description": "header slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom header template of panel."
},
{
"name": "footer",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t value: any, // Value of the component\n \t suggestions: any, // Displayed options\n }",
"description": "footer slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom footer template of panel."
},
{
"name": "option",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }",
"description": "option slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom option template."
},
{
"name": "optiongroup",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t option: any, // Option instance\n \t index: number, // Index of the option\n }",
"description": "option group slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom option group template."
},
{
"name": "content",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t items: any, // An array of objects to display for virtualscroller\n \t styleClass: string, // Style class of the component\n \t contentRef: (el: any) ⇒ void, // Referance of the content\n\t getItemOptions: (index: number) ⇒ VirtualScrollerItemOptions, // Options of the items\n}",
"description": "content slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
},
{
"name": "loader",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t options: any, // Options of the loader items for virtualscroller\n }",
"description": "loader slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom loader template."
},
{
"name": "empty",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom empty template when there is no data to display."
},
{
"name": "dropdownicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the icon.\n }"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom dropdown icon template."
},
{
"name": "removetokenicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}",
"description": "chip icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "",
"deprecated": "since v4.0. Use 'chipicon' slot instead.\nCustom chip icon template in multiple mode."
},
{
"name": "chipicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}",
"description": "chip icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom chip icon template in multiple mode."
},
{
"name": "loadingicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the loader.\n }"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "",
"deprecated": "since v4.0. Use 'loader' slot instead.\nCustom loader template."
},
{
"name": "dropdownbutton",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t toggleCallback: (event: Event) ⇒ void, // Toggle function.\n}"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "",
"deprecated": "since v4.0. Use 'dropdown' slot instead.\nCustom dropdown template."
},
{
"name": "dropdown",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t toggleCallback: (event: Event) ⇒ void, // Toggle function.\n}"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom dropdown template."
},
{
"name": "clearicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t clearCallback: (event: Event) ⇒ void, // Clear icon click function.\n}",
"description": "clear icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom clear icon template."
}
]
},
"AutoCompleteEmitsOptions": {
"description": "Defines valid emits in AutoComplete component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "update:modelValue",
"parameters": [
{
"name": "value",
"optional": false,
"type": "any",
"description": "New value."
}
],
"returnType": "void",
"description": "Emitted when the value changes."
},
{
"name": "value-change",
"parameters": [
{
"name": "value",
"optional": false,
"type": "any",
"description": "New value."
}
],
"returnType": "void",
"description": "Emitted when the value changes in uncontrolled mode."
},
{
"name": "change",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteChangeEvent",
"description": "Custom change event."
}
],
"returnType": "void",
"description": "Callback to invoke on value change."
},
{
"name": "focus",
"parameters": [
{
"name": "event",
"optional": false,
"type": "Event",
"description": "Browser event."
}
],
"returnType": "void",
"description": "Callback to invoke when the component receives focus."
},
{
"name": "blur",
"parameters": [
{
"name": "event",
"optional": false,
"type": "Event",
"description": "Browser event."
}
],
"returnType": "void",
"description": "Callback to invoke when the component loses focus."
},
{
"name": "item-select",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteOptionSelectEvent",
"description": "Custom option select event."
}
],
"returnType": "void",
"description": "",
"deprecated": "since v4.0. Use 'option-select' emit.\nCallback to invoke when a suggestion is selected."
},
{
"name": "item-unselect",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteOptionUnselectEvent",
"description": "Custom option unselect event."
}
],
"returnType": "void",
"description": "",
"deprecated": "since v4.0. Use 'option-unselect' emit.\nCallback to invoke when a selected value is removed."
},
{
"name": "option-select",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteOptionSelectEvent",
"description": "Custom option select event."
}
],
"returnType": "void",
"description": "Callback to invoke when a suggestion is selected."
},
{
"name": "option-unselect",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteOptionUnselectEvent",
"description": "Custom option unselect event."
}
],
"returnType": "void",
"description": "Callback to invoke when a selected value is removed."
},
{
"name": "dropdown-click",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteDropdownClickEvent",
"description": "Custom dropdown click event."
}
],
"returnType": "void",
"description": "Callback to invoke to when dropdown button is clicked."
},
{
"name": "clear",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke when input is cleared by the user."
},
{
"name": "complete",
"parameters": [
{
"name": "event",
"optional": false,
"type": "AutoCompleteCompleteEvent",
"description": "Custom complete event."
}
],
"returnType": "void",
"description": "Callback to invoke to search for suggestions."
},
{
"name": "before-show",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke before the overlay is shown."
},
{
"name": "before-hide",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke before the overlay is hidden."
},
{
"name": "show",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke when the overlay is shown."
},
{
"name": "hide",
"parameters": [],
"returnType": "void",
"description": "Callback to invoke when the overlay is hidden."
}
]
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AutoCompletePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AutoCompleteSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"props": []
},
"AutoCompleteChangeEvent": {
"description": "Custom change event.",
"props": []
},
"AutoCompleteOptionSelectEvent": {
"description": "Custom item select event.",
"props": []
},
"AutoCompleteOptionUnselectEvent": {
"description": "Custom item unselect event.",
"props": []
},
"AutoCompleteDropdownClickEvent": {
"description": "Custom dropdown click event.",
"props": []
},
"AutoCompleteCompleteEvent": {
"description": "Custom complete event.",
"props": []
},
"AutoCompletePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AutoCompletePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"AutoCompleteState": {
"description": "Defines current inline state in AutoComplete component.",
"props": []
},
"AutoCompleteContext": {
"description": "Defines current options in AutoComplete component.",
"props": []
},
"AutoCompleteProps": {
"description": "Defines valid properties in AutoComplete component.",
"props": []
},
"AutoCompleteSlots": {
"description": "Defines valid slots in AutoComplete component.",
"props": []
},
"AutoCompleteEmitsOptions": {
"description": "Defines valid emits in AutoComplete component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AutoCompletePassThroughOptionType": {
"values": "AutoCompletePassThroughAttributes | (options: AutoCompletePassThroughMethodOptions) => undefined | string | null | undefined"
},
"AutoCompletePassThroughTransitionType": {
"values": "TransitionProps | (options: AutoCompletePassThroughMethodOptions) => TransitionProps | undefined"
},
"AutoCompleteEmits": {
"values": "EmitFn"
}
}
}
},
"autocompletestyle": {
"description": "AutoComplete is an input component that provides real-time suggestions while being typed.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AutoCompleteStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AutoCompleteStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AutoCompleteClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-autocomplete"",
"description": "Class name of the root element"
},
{
"name": "pcInput",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-input"",
"description": "Class name of the input element"
},
{
"name": "inputMultiple",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-input-multiple"",
"description": "Class name of the input multiple element"
},
{
"name": "clearIcon",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-clear-icon"",
"description": "Class name of the clear icon element"
},
{
"name": "chipItem",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-chip-item"",
"description": "Class name of the chip item element"
},
{
"name": "pcChip",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-chip"",
"description": "Class name of the chip element"
},
{
"name": "chipIcon",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-chip-icon"",
"description": "Class name of the chip icon element"
},
{
"name": "inputChip",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-input-chip"",
"description": "Class name of the input chip element"
},
{
"name": "loader",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-loader"",
"description": "Class name of the loader element"
},
{
"name": "dropdown",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-dropdown"",
"description": "Class name of the dropdown element"
},
{
"name": "panel",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-overlay"",
"description": "Class name of the panel element"
},
{
"name": "list",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-list"",
"description": "Class name of the list element"
},
{
"name": "listContainer",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-list-container"",
"description": "Class name of the list container element"
},
{
"name": "optionGroup",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-option-group"",
"description": "Class name of the option group element"
},
{
"name": "option",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-option"",
"description": "Class name of the option element"
},
{
"name": "emptyMessage",
"optional": false,
"readonly": false,
"value": ""p-autocomplete-empty-message"",
"description": "Class name of the empty message element"
}
]
}
}
}
},
"avatar": {
"description": "Avatar represents people using icons, labels and images.\n\n- Live Demo",
"components": {
"default": {
"description": "Avatar represents people using icons, labels and images.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AvatarProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AvatarPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AvatarPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AvatarProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the label's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the icon's DOM element."
},
{
"name": "image",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the image's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AvatarProps": {
"description": "Defines valid properties in Avatar component.",
"relatedProp": "",
"props": [
{
"name": "label",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines the text to display."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines the icon to display."
},
{
"name": "image",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines the image to display."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "HintedString<"large" | "normal" | "xlarge">",
"default": "normal",
"description": "Size of the element."
},
{
"name": "shape",
"optional": true,
"readonly": false,
"type": "HintedString<"square" | "circle">",
"default": "square",
"description": "Shape of the element."
},
{
"name": "ariaLabel",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Establishes a string value that labels the component."
},
{
"name": "ariaLabelledby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"AvatarSlots": {
"description": "Defines valid slots in Avatar component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Content can easily be customized with the default slot instead of using the built-in modes."
},
{
"name": "icon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom icon template."
}
]
},
"AvatarEmitsOptions": {
"description": "Defines valid emits in Avatar component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "error",
"parameters": [
{
"name": "event",
"optional": false,
"type": "Event"
}
],
"returnType": "void",
"description": "Triggered when an error occurs while loading an image file."
}
]
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AvatarPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AvatarPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"AvatarPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AvatarProps": {
"description": "Defines valid properties in Avatar component.",
"props": []
},
"AvatarSlots": {
"description": "Defines valid slots in Avatar component.",
"props": []
},
"AvatarEmitsOptions": {
"description": "Defines valid emits in Avatar component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AvatarPassThroughOptionType": {
"values": "AvatarPassThroughAttributes | (options: AvatarPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AvatarEmits": {
"values": "EmitFn"
}
}
}
},
"avatarstyle": {
"description": "Avatar represents people using icons, labels and images.\n\n- Live Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AvatarStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AvatarClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-avatar"",
"description": "Class name of the root element"
},
{
"name": "label",
"optional": false,
"readonly": false,
"value": ""p-avatar-label"",
"description": "Class name of the label element"
},
{
"name": "icon",
"optional": false,
"readonly": false,
"value": ""p-avatar-icon"",
"description": "Class name of the icon element"
}
]
}
}
}
},
"avatargroup": {
"description": "A set of Avatars can be displayed together using the AvatarGroup component.\n\nLive Demo",
"components": {
"default": {
"description": "A set of Avatars can be displayed together using the AvatarGroup component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarGroupPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AvatarGroupProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"AvatarGroupPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AvatarGroupPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AvatarGroupProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AvatarGroupPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"AvatarGroupProps": {
"description": "Defines valid properties in AvatarGroup component.",
"relatedProp": "",
"props": [
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"AvatarGroupSlots": {
"description": "Defines valid slots in AvatarGroup component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Default slot to detect Avatar components."
}
]
},
"AvatarGroupEmitsOptions": {
"description": "Defines valid emits in AvatarGroup component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AvatarGroupPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"AvatarGroupPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"AvatarGroupPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"AvatarGroupProps": {
"description": "Defines valid properties in AvatarGroup component.",
"props": []
},
"AvatarGroupSlots": {
"description": "Defines valid slots in AvatarGroup component.",
"props": []
},
"AvatarGroupEmitsOptions": {
"description": "Defines valid emits in AvatarGroup component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AvatarGroupPassThroughOptionType": {
"values": "AvatarGroupPassThroughAttributes | (options: AvatarGroupPassThroughMethodOptions) => undefined | string | null | undefined"
},
"AvatarGroupEmits": {
"values": "EmitFn"
}
}
}
},
"avatargroupstyle": {
"description": "A set of Avatars can be displayed together using the AvatarGroup component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarGroupStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"AvatarGroupStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"AvatarGroupClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-avatar-group""
}
]
}
}
}
},
"badge": {
"description": "Badge represents people using icons, labels and images.\n\nLive Demo",
"components": {
"default": {
"description": "Badge represents people using icons, labels and images.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BadgePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "BadgeProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "T",
"default": "",
"description": "Defines parent instance."
}
],
"methods": []
},
"BadgePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"BadgePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "BadgeProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "BadgePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"BadgeProps": {
"description": "Defines valid properties in Badge component.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": true,
"readonly": false,
"type": "string | number",
"default": "",
"description": "Value to display inside the badge."
},
{
"name": "severity",
"optional": true,
"readonly": false,
"type": "null | HintedString<"secondary" | "info" | "success" | "warn" | "danger" | "contrast">",
"default": "",
"description": "Severity type of the badge."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "null | HintedString<"small" | "large" | "xlarge">",
"default": "",
"description": "Size of the badge, valid options are 'small', 'large', and 'xlarge'."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough>",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"BadgeSlots": {
"description": "Defines valid slots in Badge component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Content can easily be customized with the default slot instead of using the built-in display."
}
]
},
"BadgeEmitsOptions": {
"description": "Defines valid emits in Badge component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BadgePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"BadgePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"BadgePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"BadgeProps": {
"description": "Defines valid properties in Badge component.",
"props": []
},
"BadgeSlots": {
"description": "Defines valid slots in Badge component.",
"props": []
},
"BadgeEmitsOptions": {
"description": "Defines valid emits in Badge component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"BadgePassThroughOptionType": {
"values": "BadgePassThroughAttributes | (options: BadgePassThroughMethodOptions) => undefined | string | null | undefined"
},
"BadgeEmits": {
"values": "EmitFn"
}
}
}
},
"badgestyle": {
"description": "Badge represents people using icons, labels and images.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BadgeStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BadgeStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"BadgeClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-badge"",
"description": "Class name of the root element"
}
]
}
}
}
},
"badgedirective": {
"description": "Badge directive is a small status indicator for another element.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BadgeDirectivePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "context",
"optional": false,
"readonly": false,
"type": "BadgeContext",
"default": ""
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"BadgeDirectiveOptions": {
"description": "Defines options of Badge.",
"relatedProp": "",
"props": [
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"BadgeDirectivePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "BadgeDirectiveOptions.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "BadgeDirectivePassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"BadgeDirectivePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"BadgeContext": {
"description": "Defines current options in Badge directive.",
"relatedProp": "",
"props": [
{
"name": "info",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Current info state as a boolean."
},
{
"name": "success",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current success state as a boolean."
},
{
"name": "warn",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current warn state as a boolean."
},
{
"name": "danger",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current danger state as a boolean."
},
{
"name": "nogutter",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Current gutter state as a boolean."
},
{
"name": "dot",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "",
"description": "Current dot state as a boolean."
}
],
"methods": []
},
"BadgeDirectiveModifiers": {
"description": "Defines modifiers of Badge directive.",
"relatedProp": "",
"props": [
{
"name": "info",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Info severity for Badge directive."
},
{
"name": "success",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Success severity for Badge directive."
},
{
"name": "warn",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "warn severity for Badge directive."
},
{
"name": "danger",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Danger severity for Badge directive."
}
],
"methods": []
},
"BadgeDirectiveBinding": {
"description": "Binding of Badge directive.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "null | ComponentPublicInstance<Object, Object, Object, Object, Object, Object, Object, Object, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, Object, Object, string, Object, Object, Object, string, ComponentProvideOptions>, Object, Object, "", Object, any> | Record<string, any>",
"default": ""
},
{
"name": "oldValue",
"optional": false,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "arg",
"optional": true,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "dir",
"optional": false,
"readonly": false,
"type": "ObjectDirective<any, any, string, any>",
"default": ""
},
{
"name": "value",
"optional": true,
"readonly": false,
"type": "string | BadgeDirectiveOptions",
"default": "",
"description": "Value of the Badge."
},
{
"name": "modifiers",
"optional": true,
"readonly": false,
"type": "BadgeDirectiveModifiers",
"default": "",
"description": "Modifiers of the Badge."
}
],
"methods": [],
"extendedTypes": "Omit<DirectiveBinding, "modifiers" | "value">"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BadgeDirectivePassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"BadgeDirectiveOptions": {
"description": "Defines options of Badge.",
"props": []
},
"BadgeDirectivePassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"BadgeDirectivePassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"BadgeContext": {
"description": "Defines current options in Badge directive.",
"props": []
},
"BadgeDirectiveModifiers": {
"description": "Defines modifiers of Badge directive.",
"props": []
},
"BadgeDirectiveBinding": {
"description": "Binding of Badge directive.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"BadgeDirectivePassThroughOptionType": {
"values": "BadgeDirectivePassThroughAttributes | (options: BadgeDirectivePassThroughMethodOptions) => BadgeDirectivePassThroughAttributes | null | undefined"
}
}
}
},
"badgedirectivestyle": {
"description": "Badge directive is a small status indicator for another element.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BadgeDirectiveStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BadgeDirectiveStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"BadgeDirectiveClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-badge""
}
]
}
}
}
},
"blockui": {
"description": "BlockUI represents people using icons, labels and images.\n\nLive Demo",
"components": {
"default": {
"description": "BlockUI represents people using icons, labels and images.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BlockUIPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "BlockUIProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "BlockUIState",
"default": "",
"description": "Defines current inline state."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"BlockUIPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "BlockUIProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "BlockUIPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "mask",
"optional": true,
"readonly": false,
"type": "BlockUIPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the mask's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"BlockUIPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"BlockUIState": {
"description": "Defines current inline state in BlockUI component.",
"relatedProp": "",
"props": [
{
"name": "isBlocked",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current blocked state as a boolean."
}
],
"methods": []
},
"BlockUIProps": {
"description": "Defines valid properties in BlockUI component",
"relatedProp": "",
"props": [
{
"name": "blocked",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Controls the blocked state."
},
{
"name": "fullScreen",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, the whole document gets blocked."
},
{
"name": "baseZIndex",
"optional": true,
"readonly": false,
"type": "number",
"default": "0",
"description": "Base zIndex value to use in layering."
},
{
"name": "autoZIndex",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether to automatically manage layering."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"BlockUISlots": {
"description": "Defines valid slots in BlockUI component",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content's slot."
}
]
},
"BlockUIEmitsOptions": {
"description": "Defines valid emits in BlockUI component",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "block",
"parameters": [],
"returnType": "void",
"description": "Fired when the element gets blocked."
},
{
"name": "unblock",
"parameters": [],
"returnType": "void",
"description": "Fired when the element gets unblocked."
}
]
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BlockUIPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"BlockUIPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"BlockUIPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"BlockUIState": {
"description": "Defines current inline state in BlockUI component.",
"props": []
},
"BlockUIProps": {
"description": "Defines valid properties in BlockUI component",
"props": []
},
"BlockUISlots": {
"description": "Defines valid slots in BlockUI component",
"props": []
},
"BlockUIEmitsOptions": {
"description": "Defines valid emits in BlockUI component",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"BlockUIPassThroughOptionType": {
"values": "BlockUIPassThroughAttributes | (options: BlockUIPassThroughMethodOptions) => undefined | string | null | undefined"
},
"BlockUIEmits": {
"values": "EmitFn"
}
}
}
},
"blockuistyle": {
"description": "BlockUI represents people using icons, labels and images.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BlockUIStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BlockUIStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"BlockUIClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-blockui"",
"description": "Class name of the root element"
}
]
}
}
}
},
"breadcrumb": {
"description": "Breadcrumb provides contextual information about page hierarchy.\n\nLive Demo",
"components": {
"default": {
"description": "Breadcrumb provides contextual information about page hierarchy.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BreadcrumbPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "BreadcrumbProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "BreadcrumbContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"BreadcrumbPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "BreadcrumbProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "list",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the list's DOM element."
},
{
"name": "item",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item's DOM element."
},
{
"name": "itemLink",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item link's DOM element."
},
{
"name": "itemIcon",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item icon's DOM element."
},
{
"name": "itemLabel",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item label's DOM element."
},
{
"name": "separator",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the separator's DOM element."
},
{
"name": "separatorIcon",
"optional": true,
"readonly": false,
"type": "BreadcrumbPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the separator icon's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"BreadcrumbPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"BreadcrumbContext": {
"description": "Defines current options in Breadcrumb component.",
"relatedProp": "",
"props": [
{
"name": "item",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Current menuitem"
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Index of the menuitem"
}
],
"methods": []
},
"BreadcrumbRouterBindProps": {
"description": "Defines valid router binding props in Breadcrumb component.",
"relatedProp": "",
"props": [
{
"name": "action",
"optional": false,
"readonly": false,
"type": "object",
"default": "",
"description": "Action element binding"
},
{
"name": "icon",
"optional": false,
"readonly": false,
"type": "object",
"default": "",
"description": "Icon element binding"
},
{
"name": "label",
"optional": false,
"readonly": false,
"type": "object",
"default": "",
"description": "Label element binding"
}
],
"methods": []
},
"BreadcrumbProps": {
"description": "Defines valid properties in Breadcrumb component.",
"relatedProp": "",
"props": [
{
"name": "model",
"optional": true,
"readonly": false,
"type": "MenuItem[]",
"default": "",
"description": "An array of menuitems."
},
{
"name": "home",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Configuration for the home icon."
},
{
"name": "ariaLabel",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines a string value that labels an interactive element."
},
{
"name": "ariaLabelledby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifier of the underlying menu element."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"BreadcrumbSlots": {
"description": "Defines valid slots in Breadcrumb component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "item",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: BreadcrumbRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom item template."
},
{
"name": "separator",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom separator template."
},
{
"name": "itemicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t item: MenuItem, // Menuitem instance\n \t class: any, // Style class of the item icon element.\n }",
"description": "item icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom item icon template."
}
]
},
"BreadcrumbEmitsOptions": {
"description": "Defines valid emits in Breadcrumb component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BreadcrumbPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"BreadcrumbPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"BreadcrumbPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"BreadcrumbContext": {
"description": "Defines current options in Breadcrumb component.",
"props": []
},
"BreadcrumbRouterBindProps": {
"description": "Defines valid router binding props in Breadcrumb component.",
"props": []
},
"BreadcrumbProps": {
"description": "Defines valid properties in Breadcrumb component.",
"props": []
},
"BreadcrumbSlots": {
"description": "Defines valid slots in Breadcrumb component.",
"props": []
},
"BreadcrumbEmitsOptions": {
"description": "Defines valid emits in Breadcrumb component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"BreadcrumbPassThroughOptionType": {
"values": "BreadcrumbPassThroughAttributes | (options: BreadcrumbPassThroughMethodOptions) => undefined | string | null | undefined"
},
"BreadcrumbEmits": {
"values": "EmitFn"
}
}
}
},
"breadcrumbstyle": {
"description": "Breadcrumb provides contextual information about page hierarchy.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"BreadcrumbStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"BreadcrumbStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"BreadcrumbClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb"",
"description": "Class name of the root element"
},
{
"name": "list",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-list"",
"description": "Class name of the list element"
},
{
"name": "homeItem",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-home-item"",
"description": "Class name of the home item element"
},
{
"name": "separator",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-separator"",
"description": "Class name of the separator element"
},
{
"name": "separatorIcon",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-separator-icon"",
"description": "Class name of the separator icon element"
},
{
"name": "item",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-item"",
"description": "Class name of the item element"
},
{
"name": "itemLink",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-item-link"",
"description": "Class name of the item link element"
},
{
"name": "itemIcon",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-item-icon"",
"description": "Class name of the item icon element"
},
{
"name": "itemLabel",
"optional": false,
"readonly": false,
"value": ""p-breadcrumb-item-label"",
"description": "Class name of the item label element"
}
]
}
}
}
},
"button": {
"description": "Button is an extension to standard button element with icons and theming.\n\nLive Demo",
"components": {
"default": {
"description": "Button is an extension to standard button element with icons and theming.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ButtonPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ButtonProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "ButtonContext",
"default": "",
"description": "Defines current options."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "T",
"default": "",
"description": "Defines parent instance."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"ButtonPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "ButtonProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "ButtonPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "ButtonPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the loading icon's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "ButtonPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the icon's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "ButtonPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the label's DOM element."
},
{
"name": "pcBadge",
"optional": true,
"readonly": false,
"type": "ButtonPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the Badge component."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"ButtonPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"ButtonProps": {
"description": "Defines valid properties in Button component.",
"relatedProp": "",
"props": [
{
"name": "aria-activedescendant",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application."
},
{
"name": "aria-atomic",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute."
},
{
"name": "aria-autocomplete",
"optional": true,
"readonly": false,
"type": ""none" | "inline" | "list" | "both"",
"default": "",
"description": "Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be\npresented if they are made."
},
{
"name": "aria-busy",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user."
},
{
"name": "aria-checked",
"optional": true,
"readonly": false,
"type": "Booleanish | "mixed"",
"default": "",
"description": "Indicates the current "checked" state of checkboxes, radio buttons, and other widgets."
},
{
"name": "aria-colcount",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the total number of columns in a table, grid, or treegrid."
},
{
"name": "aria-colindex",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid."
},
{
"name": "aria-colspan",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid."
},
{
"name": "aria-controls",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the element (or elements) whose contents or presence are controlled by the current element."
},
{
"name": "aria-current",
"optional": true,
"readonly": false,
"type": "Booleanish | "page" | "step" | "location" | "date" | "time"",
"default": "",
"description": "Indicates the element that represents the current item within a container or set of related elements."
},
{
"name": "aria-describedby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the element (or elements) that describes the object."
},
{
"name": "aria-details",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the element that provides a detailed, extended description for the object."
},
{
"name": "aria-disabled",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable."
},
{
"name": "aria-dropeffect",
"optional": true,
"readonly": false,
"type": ""link" | "none" | "copy" | "execute" | "move" | "popup"",
"default": "",
"description": "Indicates what functions can be performed when a dragged object is released on the drop target.",
"deprecated": "in ARIA 1.1"
},
{
"name": "aria-errormessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the element that provides an error message for the object."
},
{
"name": "aria-expanded",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed."
},
{
"name": "aria-flowto",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\nallows assistive technology to override the general default of reading in document source order."
},
{
"name": "aria-grabbed",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates an element's "grabbed" state in a drag-and-drop operation.",
"deprecated": "in ARIA 1.1"
},
{
"name": "aria-haspopup",
"optional": true,
"readonly": false,
"type": "Booleanish | "menu" | "listbox" | "tree" | "grid" | "dialog"",
"default": "",
"description": "Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element."
},
{
"name": "aria-hidden",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates whether the element is exposed to an accessibility API."
},
{
"name": "aria-invalid",
"optional": true,
"readonly": false,
"type": "Booleanish | "grammar" | "spelling"",
"default": "",
"description": "Indicates the entered value does not conform to the format expected by the application."
},
{
"name": "aria-keyshortcuts",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element."
},
{
"name": "aria-label",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines a string value that labels the current element."
},
{
"name": "aria-labelledby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies the element (or elements) that labels the current element."
},
{
"name": "aria-level",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the hierarchical level of an element within a structure."
},
{
"name": "aria-live",
"optional": true,
"readonly": false,
"type": ""off" | "assertive" | "polite"",
"default": "",
"description": "Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region."
},
{
"name": "aria-modal",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates whether an element is modal when displayed."
},
{
"name": "aria-multiline",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates whether a text box accepts multiple lines of input or only a single line."
},
{
"name": "aria-multiselectable",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates that the user may select more than one item from the current selectable descendants."
},
{
"name": "aria-orientation",
"optional": true,
"readonly": false,
"type": ""horizontal" | "vertical"",
"default": "",
"description": "Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous."
},
{
"name": "aria-owns",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship\nbetween DOM elements where the DOM hierarchy cannot be used to represent the relationship."
},
{
"name": "aria-placeholder",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.\nA hint could be a sample value or a brief description of the expected format."
},
{
"name": "aria-posinset",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM."
},
{
"name": "aria-pressed",
"optional": true,
"readonly": false,
"type": "Booleanish | "mixed"",
"default": "",
"description": "Indicates the current "pressed" state of toggle buttons."
},
{
"name": "aria-readonly",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates that the element is not editable, but is otherwise operable."
},
{
"name": "aria-relevant",
"optional": true,
"readonly": false,
"type": ""text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"",
"default": "",
"description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified."
},
{
"name": "aria-required",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates that user input is required on the element before a form may be submitted."
},
{
"name": "aria-roledescription",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines a human-readable, author-localized description for the role of an element."
},
{
"name": "aria-rowcount",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the total number of rows in a table, grid, or treegrid."
},
{
"name": "aria-rowindex",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid."
},
{
"name": "aria-rowspan",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid."
},
{
"name": "aria-selected",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": "",
"description": "Indicates the current "selected" state of various widgets."
},
{
"name": "aria-setsize",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM."
},
{
"name": "aria-sort",
"optional": true,
"readonly": false,
"type": ""none" | "ascending" | "descending" | "other"",
"default": "",
"description": "Indicates if items in a table or grid are sorted in ascending or descending order."
},
{
"name": "aria-valuemax",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the maximum allowed value for a range widget."
},
{
"name": "aria-valuemin",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the minimum allowed value for a range widget."
},
{
"name": "aria-valuenow",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": "",
"description": "Defines the current value for a range widget."
},
{
"name": "aria-valuetext",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Defines the human readable text alternative of aria-valuenow for a range widget."
},
{
"name": "innerHTML",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "accesskey",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "contenteditable",
"optional": true,
"readonly": false,
"type": "Booleanish | "inherit" | "plaintext-only"",
"default": ""
},
{
"name": "contextmenu",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "dir",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "draggable",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "enterkeyhint",
"optional": true,
"readonly": false,
"type": ""enter" | "done" | "go" | "next" | "previous" | "search" | "send"",
"default": ""
},
{
"name": "enterKeyHint",
"optional": true,
"readonly": false,
"type": ""enter" | "done" | "go" | "next" | "previous" | "search" | "send"",
"default": "",
"description": "",
"deprecated": "Use "
},
{
"name": "hidden",
"optional": true,
"readonly": false,
"type": """ | Booleanish | "hidden" | "until-found"",
"default": ""
},
{
"name": "id",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "inert",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "lang",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "placeholder",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "spellcheck",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "tabindex",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": ""
},
{
"name": "title",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "translate",
"optional": true,
"readonly": false,
"type": ""yes" | "no"",
"default": ""
},
{
"name": "radiogroup",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "role",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "about",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "datatype",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "inlist",
"optional": true,
"readonly": false,
"type": "any",
"default": ""
},
{
"name": "prefix",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "property",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "resource",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "typeof",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "vocab",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "autocapitalize",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "autocorrect",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "autosave",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "color",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "itemprop",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "itemscope",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "itemtype",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "itemid",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "itemref",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "results",
"optional": true,
"readonly": false,
"type": "Numberish",
"default": ""
},
{
"name": "security",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "unselectable",
"optional": true,
"readonly": false,
"type": ""on" | "off"",
"default": ""
},
{
"name": "inputmode",
"optional": true,
"readonly": false,
"type": ""text" | "search" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"",
"default": "",
"description": "Hints at the type of data that might be entered by the user while editing the element or its contents"
},
{
"name": "is",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Specify that a standard HTML element should behave like a defined custom built-in element"
},
{
"name": "exportparts",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": ""
},
{
"name": "part",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": ""
},
{
"name": "autofocus",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "form",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "formaction",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "formenctype",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "formmethod",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "formnovalidate",
"optional": true,
"readonly": false,
"type": "Booleanish",
"default": ""
},
{
"name": "formtarget",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "name",
"optional": true,
"readonly": false,
"type": "string",
"default": ""
},
{
"name": "type",
"optional": true,
"readonly": false,
"type": ""submit" | "reset" | "button"",
"default": ""
},
{
"name": "value",
"optional": true,
"readonly": false,
"type": "string | number | readonly string[]",
"default": ""
},
{
"name": "onCopy",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCut",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPaste",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCompositionend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCompositionstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCompositionupdate",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDrag",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragenter",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragexit",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragleave",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragover",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDragstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDrop",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFocus",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFocusin",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFocusout",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBlur",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onChange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBeforeinput",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFormdata",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInput",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onReset",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSubmit",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onInvalid",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFullscreenchange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onFullscreenerror",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onLoad",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onError",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onKeydown",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onKeypress",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onKeyup",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDblclick",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMousedown",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMouseenter",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMouseleave",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMousemove",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMouseout",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMouseover",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onMouseup",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAbort",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCanplay",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onCanplaythrough",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onDurationchange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onEmptied",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onEncrypted",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onEnded",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onLoadeddata",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onLoadedmetadata",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onLoadstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPause",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPlay",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPlaying",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onProgress",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onRatechange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSeeked",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSeeking",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onStalled",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSuspend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTimeupdate",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onVolumechange",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onWaiting",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSelect",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onScroll",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onScrollend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTouchcancel",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTouchend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTouchmove",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTouchstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAuxclick",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onClick",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onContextmenu",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onGotpointercapture",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onLostpointercapture",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerdown",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointermove",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerup",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointercancel",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerenter",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerleave",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerover",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onPointerout",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onBeforetoggle",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onToggle",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onWheel",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAnimationcancel",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAnimationstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAnimationend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onAnimationiteration",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onSecuritypolicyviolation",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTransitioncancel",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTransitionend",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTransitionrun",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "onTransitionstart",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "style",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Inline style of the button."
},
{
"name": "class",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the button."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Text of the button."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Name of the icon."
},
{
"name": "iconPos",
"optional": true,
"readonly": false,
"type": "HintedString<"left" | "right" | "top" | "bottom">",
"default": "left",
"description": "Position of the icon."
},
{
"name": "iconClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the icon."
},
{
"name": "badge",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Value of the badge."
},
{
"name": "badgeClass",
"optional": true,
"readonly": false,
"type": "string | object",
"default": "",
"description": "Style class of the badge."
},
{
"name": "badgeSeverity",
"optional": true,
"readonly": false,
"type": "null | HintedString<"secondary" | "info" | "success" | "warn" | "danger" | "contrast">",
"default": "",
"description": "Severity type of the badge."
},
{
"name": "loading",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the button is in loading state."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Icon to display in loading state."
},
{
"name": "as",
"optional": true,
"readonly": false,
"type": "string | Component",
"default": "BUTTON",
"description": "Use to change the HTML tag of root element."
},
{
"name": "asChild",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it changes the default rendered element for the one passed as a child element."
},
{
"name": "link",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a link style to the button."
},
{
"name": "severity",
"optional": true,
"readonly": false,
"type": "HintedString<"secondary" | "info" | "success" | "warn" | "danger" | "contrast" | "help">",
"default": "",
"description": "Defines the style of the button."
},
{
"name": "raised",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a shadow to indicate elevation."
},
{
"name": "rounded",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a circular border radius to the button."
},
{
"name": "text",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a textual class to the button without a background initially."
},
{
"name": "outlined",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a border class without a background initially."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "HintedString<"small" | "large">",
"default": "",
"description": "Defines the size of the button."
},
{
"name": "variant",
"optional": true,
"readonly": false,
"type": "HintedString<"outlined" | "text" | "link">",
"default": "undefined",
"description": "Specifies the variant of the component."
},
{
"name": "plain",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Add a plain textual class to the button without a background initially.",
"deprecated": "since v4.2.0. Use a contrast severity instead."
},
{
"name": "fluid",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "null",
"description": "Spans 100% width of the container when enabled."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough>",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": [],
"extendedTypes": "ButtonHTMLAttributes"
},
"ButtonContext": {
"description": "Defines current options in Button component.",
"relatedProp": "",
"props": [
{
"name": "disabled",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current disabled state of the element as a boolean."
}
],
"methods": []
},
"ButtonSlots": {
"description": "Defines valid slots in Button component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the button.\n \t a11yAttrs: Record, // Object containing the accessibility attributes.\n }"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content such as icons, images and text can be placed inside the button via the default slot. Note that when slot is used, label, icon and badge properties are not included."
},
{
"name": "icon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the icon.\n }",
"description": "icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom icon template."
},
{
"name": "loadingicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t class: string, // Style class of the loading icon.\n }",
"description": "loading icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom loading icon template."
}
]
},
"ButtonEmitsOptions": {
"description": "Defines valid emits in Button component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"ButtonPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"ButtonPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"ButtonPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"ButtonProps": {
"description": "Defines valid properties in Button component.",
"props": []
},
"ButtonContext": {
"description": "Defines current options in Button component.",
"props": []
},
"ButtonSlots": {
"description": "Defines valid slots in Button component.",
"props": []
},
"ButtonEmitsOptions": {
"description": "Defines valid emits in Button component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"ButtonPassThroughOptionType": {
"values": "ButtonPassThroughAttributes | (options: ButtonPassThroughMethodOptions) => undefined | string | null | undefined"
},
"ButtonEmits": {
"values": "EmitFn"
}
}
}
},
"buttonstyle": {
"description": "Button is an extension to standard button element with icons and theming.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ButtonStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"ButtonStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"ButtonClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-button"",
"description": "Class name of the root element"
},
{
"name": "loadingIcon",
"optional": false,
"readonly": false,
"value": ""p-button-loading-icon"",
"description": "Class name of the loading icon element"
},
{
"name": "icon",
"optional": false,
"readonly": false,
"value": ""p-button-icon"",
"description": "Class name of the icon element"
},
{
"name": "label",
"optional": false,
"readonly": false,
"value": ""p-button-label"",
"description": "Class name of the label element"
}
]
}
}
}
},
"buttongroup": {
"description": "A set of Buttons can be displayed together using the ButtonGroup component.\n\nLive Demo",
"components": {
"default": {
"description": "A set of Buttons can be displayed together using the ButtonGroup component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ButtonGroupPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ButtonGroupProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"ButtonGroupPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "ButtonGroupProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "ButtonGroupPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"ButtonGroupPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"ButtonGroupProps": {
"description": "Defines valid properties in ButtonGroup component.",
"relatedProp": "",
"props": [
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"ButtonGroupSlots": {
"description": "Defines valid slots in ButtonGroup component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "default",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Default slot to detect Button components."
}
]
},
"ButtonGroupEmitsOptions": {
"description": "Defines valid emits in ButtonGroup component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"ButtonGroupPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"ButtonGroupPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"ButtonGroupPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"ButtonGroupProps": {
"description": "Defines valid properties in ButtonGroup component.",
"props": []
},
"ButtonGroupSlots": {
"description": "Defines valid slots in ButtonGroup component.",
"props": []
},
"ButtonGroupEmitsOptions": {
"description": "Defines valid emits in ButtonGroup component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"ButtonGroupPassThroughOptionType": {
"values": "ButtonGroupPassThroughAttributes | (options: ButtonGroupPassThroughMethodOptions) => undefined | string | null | undefined"
},
"ButtonGroupEmits": {
"values": "EmitFn"
}
}
}
},
"buttongroupstyle": {
"description": "A set of Buttons can be displayed together using the ButtonGroup component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"ButtonGroupStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"ButtonGroupStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"ButtonGroupClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-buttongroup"",
"description": "Class name of the root element"
}
]
}
}
}
},
"calendar": {
"description": "Calendar also known as DatePicker, is a form component to work with dates.\n\nLive Demo",
"components": {
"default": {
"description": "",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CalendarPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarResponsiveOptions": {
"description": "Custom Calendar responsive options metadata.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarMonthChangeEvent": {
"description": "Custom Calendar month change event.",
"relatedProp": "CalendarEmitsOptions['month-change']",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarYearChangeEvent": {
"description": "Custom Calendar year change event.",
"relatedProp": "CalendarEmitsOptions['year-change']",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarBlurEvent": {
"description": "Custom Calendar blur event.",
"relatedProp": "CalendarEmitsOptions['blur']",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "undefined.CalendarProps.pt",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarState": {
"description": "Defines current inline state in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarDateContext": {
"description": "Defines current date options in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarContext": {
"description": "Defines current options in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarMonthOptions": {
"description": "Defines current month options.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarYearOptions": {
"description": "Defines current year options.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarProps": {
"description": "Defines valid properties in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarDateSlotOptions": {
"description": "Defines valid options of the date slot in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarSlots": {
"description": "Defines valid slots in Calendar component.",
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
},
"CalendarEmitsOptions": {
"description": "Defines valid emits in Calendar component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CalendarPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"CalendarSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"props": []
},
"CalendarResponsiveOptions": {
"description": "Custom Calendar responsive options metadata.",
"props": []
},
"CalendarMonthChangeEvent": {
"description": "Custom Calendar month change event.",
"props": []
},
"CalendarYearChangeEvent": {
"description": "Custom Calendar year change event.",
"props": []
},
"CalendarBlurEvent": {
"description": "Custom Calendar blur event.",
"props": []
},
"CalendarPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"CalendarPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"CalendarState": {
"description": "Defines current inline state in Calendar component.",
"props": []
},
"CalendarDateContext": {
"description": "Defines current date options in Calendar component.",
"props": []
},
"CalendarContext": {
"description": "Defines current options in Calendar component.",
"props": []
},
"CalendarMonthOptions": {
"description": "Defines current month options.",
"props": []
},
"CalendarYearOptions": {
"description": "Defines current year options.",
"props": []
},
"CalendarProps": {
"description": "Defines valid properties in Calendar component.",
"props": []
},
"CalendarDateSlotOptions": {
"description": "Defines valid options of the date slot in Calendar component.",
"props": []
},
"CalendarSlots": {
"description": "Defines valid slots in Calendar component.",
"props": []
},
"CalendarEmitsOptions": {
"description": "Defines valid emits in Calendar component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"CalendarEmits": {
"values": "EmitFn & DatePicker.DatePickerEmits"
}
}
}
},
"calendarstyle": {
"description": "Calendar also known as DatePicker, is a form component to work with dates.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CalendarStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CalendarStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"CalendarClasses": {
"members": []
}
}
}
},
"card": {
"description": "Card is a flexible container component.\n\nLive Demo",
"components": {
"default": {
"description": "Card is a flexible container component.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CardPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "CardProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"CardPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "CardProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "header",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the header's DOM element."
},
{
"name": "body",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the body's DOM element."
},
{
"name": "caption",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the caption's DOM element."
},
{
"name": "title",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the title's DOM element."
},
{
"name": "subtitle",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the subtitle's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content's DOM element."
},
{
"name": "footer",
"optional": true,
"readonly": false,
"type": "CardPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the footer's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"CardPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"CardProps": {
"description": "Defines valid properties in Card component.",
"relatedProp": "",
"props": [
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"CardSlots": {
"description": "Defines valid slots in Card component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "header",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom header template."
},
{
"name": "title",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom title template."
},
{
"name": "subtitle",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom subtitle template."
},
{
"name": "content",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
},
{
"name": "footer",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom footer template."
}
]
},
"CardEmitsOptions": {
"description": "Defines valid emits in Card component.",
"relatedProp": "",
"props": [],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CardPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"CardPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"CardPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"CardProps": {
"description": "Defines valid properties in Card component.",
"props": []
},
"CardSlots": {
"description": "Defines valid slots in Card component.",
"props": []
},
"CardEmitsOptions": {
"description": "Defines valid emits in Card component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"CardPassThroughOptionType": {
"values": "CardPassThroughAttributes | (options: CardPassThroughMethodOptions) => undefined | string | null | undefined"
},
"CardEmits": {
"values": "EmitFn"
}
}
}
},
"cardstyle": {
"description": "Card is a flexible container component.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CardStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CardStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"CardClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-card"",
"description": "Class name of the root element"
},
{
"name": "header",
"optional": false,
"readonly": false,
"value": ""p-card-header"",
"description": "Class name of the header element"
},
{
"name": "body",
"optional": false,
"readonly": false,
"value": ""p-card-body"",
"description": "Class name of the body element"
},
{
"name": "caption",
"optional": false,
"readonly": false,
"value": ""p-card-caption"",
"description": "Class name of the caption element"
},
{
"name": "title",
"optional": false,
"readonly": false,
"value": ""p-card-title"",
"description": "Class name of the title element"
},
{
"name": "subtitle",
"optional": false,
"readonly": false,
"value": ""p-card-subtitle"",
"description": "Class name of the subtitle element"
},
{
"name": "content",
"optional": false,
"readonly": false,
"value": ""p-card-content"",
"description": "Class name of the content element"
},
{
"name": "footer",
"optional": false,
"readonly": false,
"value": ""p-card-footer"",
"description": "Class name of the footer element"
}
]
}
}
}
},
"carousel": {
"description": "Carousel is a content slider featuring various customization options.\n\nLive Demo",
"components": {
"default": {
"description": "Carousel is a content slider featuring various customization options.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CarouselPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "CarouselProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "CarouselState",
"default": "",
"description": "Defines current inline state."
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "CarouselContext",
"default": "",
"description": "Defines current options."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"CarouselSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "CarouselProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "CarouselState",
"default": "",
"description": "Defines current inline state."
}
],
"methods": []
},
"CarouselPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "CarouselProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "header",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the header's DOM element."
},
{
"name": "contentContainer",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content container's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the content's DOM element."
},
{
"name": "pcPrevButton",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to pass attributes to the previous button's DOM element."
},
{
"name": "viewport",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the viewport's DOM element."
},
{
"name": "itemList",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the items list's DOM element."
},
{
"name": "itemClone",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item clone's DOM element."
},
{
"name": "item",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the item's DOM element."
},
{
"name": "pcNextButton",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to pass attributes to the next button's DOM element."
},
{
"name": "indicatorList",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the indicator list's DOM element."
},
{
"name": "indicator",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the indicator's DOM element."
},
{
"name": "indicatorButton",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the indicator button's DOM element."
},
{
"name": "footer",
"optional": true,
"readonly": false,
"type": "CarouselPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the footer's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"CarouselPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"CarouselState": {
"description": "Defines current inline state in Carousel component.",
"relatedProp": "",
"props": [
{
"name": "remainingItems",
"optional": false,
"readonly": false,
"type": "number",
"default": "0",
"description": "Remaining items' count as a number."
},
{
"name": "d_numVisible",
"optional": false,
"readonly": false,
"type": "number",
"default": "1",
"description": "Number of items per page as a number."
},
{
"name": "d_numScroll",
"optional": false,
"readonly": false,
"type": "number",
"default": "1",
"description": "Number of items to scroll as a number."
},
{
"name": "d_oldNumScroll",
"optional": false,
"readonly": false,
"type": "number",
"default": "0",
"description": "Old number of items to scroll as a number."
},
{
"name": "d_oldNumVisible",
"optional": false,
"readonly": false,
"type": "number",
"default": "0",
"description": "Old number of items per page as a number."
},
{
"name": "d_oldValue",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Old array of objects to display."
},
{
"name": "d_page",
"optional": false,
"readonly": false,
"type": "number",
"default": "0",
"description": "Index of the first item."
},
{
"name": "totalShiftedItems",
"optional": false,
"readonly": false,
"type": "number",
"default": "0",
"description": "Total shifted items' count as a number."
},
{
"name": "allowAutoplay",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Allow autoplay as a boolean."
},
{
"name": "d_circular",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Defines if scrolling would be infinite as a boolean."
},
{
"name": "swipeThreshold",
"optional": false,
"readonly": false,
"type": "number",
"default": "20",
"description": "Swipe threshold count as a number."
}
],
"methods": []
},
"CarouselContext": {
"description": "Defines current inline options in Carousel component.",
"relatedProp": "",
"props": [
{
"name": "highlighted",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current highlighted state of the indicator as a boolean."
},
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Index of the item as a number."
},
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current active state of the item as a boolean."
},
{
"name": "start",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current start state of the item as a boolean."
},
{
"name": "end",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current end state of the item as a boolean."
}
],
"methods": []
},
"CarouselResponsiveOptions": {
"relatedProp": "",
"props": [
{
"name": "breakpoint",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Breakpoint for responsive mode. Exp;"
},
{
"name": "numVisible",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "The number of visible items on breakpoint."
},
{
"name": "numScroll",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "The number of scrolled items on breakpoint."
}
],
"methods": []
},
"CarouselProps": {
"description": "Defines valid properties in Carousel component.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "An array of objects to display."
},
{
"name": "page",
"optional": true,
"readonly": false,
"type": "number",
"default": "0",
"description": "Index of the first item."
},
{
"name": "numVisible",
"optional": true,
"readonly": false,
"type": "number",
"default": "1",
"description": "Number of items per page."
},
{
"name": "numScroll",
"optional": true,
"readonly": false,
"type": "number",
"default": "1",
"description": "Number of items to scroll."
},
{
"name": "responsiveOptions",
"optional": true,
"readonly": false,
"type": "CarouselResponsiveOptions[]",
"default": "",
"description": "An array of options for responsive design."
},
{
"name": "orientation",
"optional": true,
"readonly": false,
"type": ""horizontal" | "vertical"",
"default": "horizontal",
"description": "Specifies the layout of the component, valid values are 'horizontal' and 'vertical'."
},
{
"name": "verticalViewPortHeight",
"optional": true,
"readonly": false,
"type": "string",
"default": "300px",
"description": "Height of the viewport in vertical layout."
},
{
"name": "containerClass",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the viewport container."
},
{
"name": "contentClass",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of main content."
},
{
"name": "indicatorsContentClass",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Style class of the indicator items."
},
{
"name": "circular",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Defines if scrolling would be infinite."
},
{
"name": "autoplayInterval",
"optional": true,
"readonly": false,
"type": "number",
"default": "0",
"description": "Time in milliseconds to scroll items automatically."
},
{
"name": "showNavigators",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether to display navigation buttons in container."
},
{
"name": "showIndicators",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether to display indicator container."
},
{
"name": "prevButtonProps",
"optional": true,
"readonly": false,
"type": "object",
"default": "",
"description": "Used to pass attributes to the previous Button component."
},
{
"name": "nextButtonProps",
"optional": true,
"readonly": false,
"type": "object",
"default": "",
"description": "Used to pass attributes to the next Button component."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"CarouselSlots": {
"description": "Defines valid slots in Carousel slots.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "item",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t data: any, // Data of the component\n \t index: number, // Index of the item\n }",
"description": "item slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content for each item."
},
{
"name": "header",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom header template."
},
{
"name": "footer",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom footer template."
},
{
"name": "previcon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom previous icon template."
},
{
"name": "nexticon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom next icon template."
},
{
"name": "empty",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom empty template."
}
]
},
"CarouselEmitsOptions": {
"description": "Defines valid emits in Carousel component.",
"relatedProp": "",
"props": [],
"methods": [
{
"name": "update:page",
"parameters": [
{
"name": "value",
"optional": false,
"type": "number",
"description": "New page value."
}
],
"returnType": "void",
"description": "Emitted when the page changes."
}
]
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CarouselPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"CarouselSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"props": []
},
"CarouselPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"CarouselPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"props": []
},
"CarouselState": {
"description": "Defines current inline state in Carousel component.",
"props": []
},
"CarouselContext": {
"description": "Defines current inline options in Carousel component.",
"props": []
},
"CarouselResponsiveOptions": {
"props": []
},
"CarouselProps": {
"description": "Defines valid properties in Carousel component.",
"props": []
},
"CarouselSlots": {
"description": "Defines valid slots in Carousel slots.",
"props": []
},
"CarouselEmitsOptions": {
"description": "Defines valid emits in Carousel component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"CarouselPassThroughOptionType": {
"values": "CarouselPassThroughAttributes | (options: CarouselPassThroughMethodOptions) => undefined | string | null | undefined"
},
"CarouselEmits": {
"values": "EmitFn"
}
}
}
},
"carouselstyle": {
"description": "Carousel is a content slider featuring various customization options.\n\nLive Demo",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"CarouselStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"CarouselStyle": {
"props": []
}
}
},
"enumerations": {
"values": {
"CarouselClasses": {
"members": [
{
"name": "root",
"optional": false,
"readonly": false,
"value": ""p-carousel"",
"description": "Class name of the root element"
},
{
"name": "header",
"optional": false,
"readonly": false,
"value": ""p-carousel-header"",
"description": "Class name of the header element"
},
{
"name": "contentContainer",
"optional": false,
"readonly": false,
"value": ""p-carousel-content-container"",
"description": "Class name of the content container element"
},
{
"name": "content",
"optional": false,
"readonly": false,
"value": ""p-carousel-content"",
"description": "Class name of the content element"
},
{
"name": "pcPrevButton",
"optional": false,
"readonly": false,
"value": ""p-carousel-prev-button"",
"description": "Class name of the previous button element"
},
{
"name": "viewport",
"optional": false,
"readonly": false,
"value": ""p-carousel-viewport"",