# Technical Documentation: primefaces/primeng > ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/primefaces/primeng) ### Overview (`README.md`) # PrimeNG > [!WARNING] > **This repository is no longer under active development and receives security fixes only.** PrimeNG continues as part of [PrimeUI](https://primeui.dev/nextchapter). > Issues here are read-only. Bug reports and feature requests belong at PrimeUI; for security vulnerabilities, see [SECURITY.md](./SECURITY.md). ### The next chapter has begun. After years as an open source library, PrimeNG enters its next chapter as part of **PrimeUI**, a sustainable foundation for the libraries you rely on. ## What this means **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](./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](https://primeui.dev/nextchapter) ➡️ **The journey continues at:** [primeng.dev](https://primeng.dev) ## Thank you To everyone who used PrimeNG, 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 (`apps/showcase/README.md`) [](https://badge.fury.io/js/primeng) [](https://www.npmjs.com/package/primeng) [](https://github.com/primefaces/primeng/actions/workflows/node.js.yml) [](https://discord.gg/gzKFYnpmCY) [](https://github.com/orgs/primefaces/discussions) [](https://primeng.org) ### Website PrimeNG is a rich set of open source UI Components for Angular. Visit the [PrimeNG website](https://primeng.org/) for interactive demos, comprehensive documentation and additional resources. --- ### Overview (`packages/mcp/README.md`) # @primeng/mcp Model Context Protocol (MCP) server for PrimeNG component library. Provides AI assistants with comprehensive access to PrimeNG component documentation, props, events, templates, theming, and code examples. ## What is MCP? [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) 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 PrimeNG components and can provide accurate, up-to-date information while helping you build Angular applications. ## Installation ### Claude Code Add the PrimeNG MCP server using the CLI: ```bash # Add to your user config (available in all projects) claude mcp add primeng -s user -- npx -y @primeng/mcp # Or add to current project only claude mcp add primeng -- npx -y @primeng/mcp ``` Alternatively, use the JSON format for more control: ```bash claude mcp add-json primeng '{"command":"npx","args":["-y","@primeng/mcp"]}' -s user ``` **Useful commands:** ```bash claude mcp list # List all MCP servers claude mcp get primeng # Get server details claude mcp remove primeng # Remove the server ``` After adding, start a new Claude Code session and use `/mcp` to verify the connection. > **Reference:** [Claude Code MCP Documentation](https://code.claude.com/docs/en/mcp) --- ### VS Code **Option 1: Project Configuration** Create `.vscode/mcp.json` in your project: ```json { "servers": { "primeng": { "command": "npx", "args": ["-y", "@primeng/mcp"] } } } ``` **Option 2: Global Configuration** Create or edit `~/Library/Application Support/Code/User/mcp.json` (macOS) or `~/.config/Code/User/mcp.json` (Linux): ```json { "servers": { "primeng": { "command": "npx", "args": ["-y", "@primeng/mcp"] } } } ``` After adding, the MCP server will be available in GitHub Copilot Chat. > **Reference:** [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) --- ### Cursor **Option 1: Project Configuration** Create `.cursor/mcp.json` in your project: ```json { "mcpServers": { "primeng": { "command": "npx", "args": ["-y", "@primeng/mcp"] } } } ``` **Option 2: Global Configuration** Create or edit `~/.cursor/mcp.json` in your home directory: ```json { "mcpServers": { "primeng": { "command": "npx", "args": ["-y", "@primeng/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 PrimeNG tools when relevant. > **Reference:** [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol) --- ### OpenAI Codex CLI **Option 1: Using the CLI** ```bash codex mcp add primeng -- npx -y @primeng/mcp ``` **Option 2: Direct Configuration** Edit `~/.codex/config.toml`: ```toml [mcp_servers.primeng] command = "npx" args = ["-y", "@primeng/mcp"] ``` After adding, the MCP server will be available in both the Codex CLI and VS Code extension. > **Reference:** [OpenAI Codex MCP Documentation](https://developers.openai.com/codex/mcp/) --- ### Windsurf **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`: ```json { "mcpServers": { "primeng": { "command": "npx", "args": ["-y", "@primeng/mcp"] } } } ``` After adding, the MCP server will be available in Cascade. > **Reference:** [Windsurf MCP Documentation](https://docs.windsurf.com/windsurf/cascade/mcp) --- ### Zed Add to your Zed settings (`~/.config/zed/settings.json` on Linux, `~/Library/Application Support/Zed/settings.json` on macOS): ```json { "context_servers": { "primeng": { "command": { "path": "npx", "args": ["-y", "@primeng/mcp"] } } } } ``` After adding, restart Zed. Check the Agent Panel's settings view - a green indicator dot next to "primeng" confirms the server is active. > **Reference:** [Zed MCP Documentation](https://zed.dev/docs/ai/mcp) --- ## Available Tools ### Component Information | Tool | Description | |------|-------------| | `list_components` | List all PrimeNG components with categories | | `get_component` | Get detailed info about a specific component | | `search_components` | Search components by name or description | | `get_component_props` | Get all props for a component | | `get_component_events` | Get all events for a component | | `get_component_methods` | Get all methods for a component | | `get_component_slots` | Get all templates for a component | | `compare_components` | Compare two components side by side | | `get_categories` | Get all component categories | ### Code Examples | Tool | Description | |------|-------------| | `get_usage_example` | Get code examples for a component | | `list_examples` | List all available code examples | | `get_example` | Get a specific example by component and section | | `generate_component_template` | Generate a basic component template | ### Theming & Styling | Tool | Description | |------|-------------| | `get_component_pt` | Get Pass Through options for DOM customization | | `get_component_tokens` | Get design tokens (CSS variables) | | `get_component_styles` | Get CSS class names | | `get_theming_info` | Get theming information | | `get_theming_guide` | Get detailed theming guide | | `get_passthrough_guide` | Get Pass Through customization guide | | `get_tailwind_guide` | Get Tailwind CSS integration guide | ### Documentation & Guides | Tool | Description | |------|-------------| | `list_guides` | List all guides and documentation pages | | `get_guide` | Get a specific guide by name | | `get_configuration` | Get PrimeNG configuration options | | `get_installation` | Get installation instructions | | `get_icons_guide` | Get icons usage guide | | `get_accessibility_guide` | Get accessibility guide | | `get_accessibility_info` | Get accessibility info for a component | ### Migration | Tool | Description | |------|-------------| | `get_migration_guide` | Get migration guide overview | | `migrate_v18_to_v19` | v18 to v19 migration guide | | `migrate_v19_to_v20` | v19 to v20 migration guide | | `migrate_v20_to_v21` | v20 to v21 migration guide | ### Search & Discovery | Tool | Description | |------|-------------| | `search_all` | Search across components, guides, and props | | `suggest_component` | Suggest components based on use case | | `find_by_prop` | Find components with a specific prop | | `find_by_event` | Find components that emit a specific event | | `find_components_with_feature` | Find components supporting a feature | | `get_related_components` | Find related components | ### Utilities | Tool | Description | |------|-------------| | `get_component_url` | Get the official documentation URL | | `get_component_import` | Get the correct import statement | | `get_component_sections` | Get all sections/features for a component | | `validate_props` | Validate props for a component | | `export_component_docs` | Export documentation in markdown | | `get_form_components` | Get all form input components | | `get_data_components` | Get all data display components | | `get_overlay_components` | Get all overlay/popup components | | `get_performance_tips` | Get performance optimization tips | | `get_version_info` | Get version and compatibility info | ## Example Prompts Once installed, try asking your AI assistant: - "Show me how to use the DataTable component with sorting and filtering" - "What props does the Button component have?" - "How do I customize the Dialog component styling with Pass Through?" - "Compare the Select and Listbox components" - "What's the best component for a date picker?" - "How do I migrate from PrimeNG v20 to v21?" ## Requirements - Node.js 18+ - One of the supported AI tools (Claude Code, Cursor, OpenAI Codex, Windsurf, Zed) ## Links - [PrimeNG Documentation](https://primeng.org/) - [Model Context Protocol](https://modelcontextprotocol.io/) - [GitHub Repository](https://github.com/primefaces/primeng) - [Report Issues](https://github.com/primefaces/primeng/issues) ## License MIT --- ### Overview (`packages/primeng/README.md`) [](https://badge.fury.io/js/primeng) [](https://www.npmjs.com/package/primeng) [](https://github.com/primefaces/primeng/actions/workflows/node.js.yml) [](https://discord.gg/gzKFYnpmCY) [](https://github.com/orgs/primefaces/discussions) [](https://primeng.org) # PrimeNG Website PrimeNG is a rich set of open source UI Components for Angular. Visit the [PrimeNG website](https://primeng.org/) for interactive demos, comprehensive documentation and additional resources. --- ### Apps Showcase Doc Apidoc Index.Json (`apps/showcase/doc/apidoc/index.json`) { "accordion": { "components": { "AccordionPanel": { "description": "AccordionPanel is a helper component for Accordion component.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "value", "optional": false, "readonly": false, "type": "ModelSignal", "default": "undefined", "description": "Value of the active tab." }, { "name": "disabled", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "Disables the tab when enabled." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } }, "AccordionHeader": { "description": "AccordionHeader is a helper component for Accordion component.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] }, "templates": { "description": "Defines the templates used by the component.", "values": [ { "name": "toggleicon", "description": "Toggle icon template.", "type": "TemplateRef", "parameters": [] } ] } }, "Accordion": { "description": "Accordion groups a collection of contents in tabs.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "value", "optional": false, "readonly": false, "type": "ModelSignal", "default": "undefined", "description": "Value of the active tab." }, { "name": "multiple", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "When enabled, multiple tabs can be activated at the same time." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Class of the element.", "deprecated": "since v20.0.0, use " }, { "name": "expandIcon", "optional": false, "readonly": false, "type": "string", "description": "Icon of a collapsed tab." }, { "name": "collapseIcon", "optional": false, "readonly": false, "type": "string", "description": "Icon of an expanded tab." }, { "name": "selectOnFocus", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "When enabled, the focused tab is activated." }, { "name": "transitionOptions", "optional": false, "readonly": false, "type": "string", "default": "400ms cubic-bezier(0.86, 0, 0.07, 1)", "description": "Transition options of the animation.", "deprecated": "since v21.0.0, use " }, { "name": "motionOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "...", "description": "The motion options." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] }, "emits": { "description": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "values": [ { "name": "onClose", "parameters": [ { "name": "event", "type": "AccordionTabCloseEvent" } ], "description": "Callback to invoke when an active tab is collapsed by clicking on the header." }, { "name": "onOpen", "parameters": [ { "name": "event", "type": "AccordionTabOpenEvent" } ], "description": "Callback to invoke when a tab gets expanded." } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-accordion", "description": "Class name of the root element" }, { "class": "p-accordioncontent", "description": "Class name of the content wrapper" }, { "class": "p-accordioncontent-content", "description": "Class name of the content" }, { "class": "p-accordionheader", "description": "Class name of the header" }, { "class": "p-accordionheader-toggle-icon", "description": "Class name of the toggle icon" }, { "class": "p-accordionpanel", "description": "Class name of the panel" } ] } }, "types": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "AccordionPassThroughOptions", "description": "Defines valid pass-through options in Accordion component.", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." }, { "name": "motion", "optional": true, "readonly": false, "type": "MotionOptions", "description": "Used to pass options to the motion component/directive." } ] }, { "name": "AccordionPanelPassThroughOptions", "description": "Defines valid pass-through options in AccordionPanel component.", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the panel's DOM element." } ] }, { "name": "AccordionHeaderPassThroughOptions", "description": "Defines valid pass-through options in AccordionHeader component.", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the header's DOM element." }, { "name": "toggleicon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the toggle icon's DOM element." } ] }, { "name": "AccordionContentPassThroughOptions", "description": "Defines valid pass-through options in AccordionContent component.", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the content container's DOM element." }, { "name": "contentWrapper", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the content wrapper DOM element." }, { "name": "content", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the content's DOM element." } ] }, { "name": "AccordionTabOpenEvent", "description": "Custom tab open event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "description": "Opened tab index." } ] }, { "name": "AccordionTabCloseEvent", "description": "Custom tab close event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "description": "Opened tab index." } ] }, { "name": "AccordionToggleIconTemplateContext", "description": "Toggle icon template context.", "props": [ { "name": "active", "optional": false, "readonly": false, "type": "boolean", "description": "Represents the active status of the panel." } ] } ] } } }, "animateonscroll": { "components": { "AnimateOnScroll": { "description": "AnimateOnScroll is used to apply animations to elements when entering or leaving the viewport during scrolling.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "enterClass", "optional": false, "readonly": false, "type": "string", "description": "Selector to define the CSS class for enter animation." }, { "name": "leaveClass", "optional": false, "readonly": false, "type": "string", "description": "Selector to define the CSS class for leave animation." }, { "name": "root", "optional": false, "readonly": false, "type": "HTMLElement", "description": "Specifies the root option of the IntersectionObserver API." }, { "name": "rootMargin", "optional": false, "readonly": false, "type": "string", "description": "Specifies the rootMargin option of the IntersectionObserver API." }, { "name": "threshold", "optional": false, "readonly": false, "type": "number", "default": "0.5", "description": "Specifies the threshold option of the IntersectionObserver API" }, { "name": "once", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether the scroll event listener should be removed after initial run." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } } } }, "blockableui": { "components": {} }, "confirmaeventtype": { "components": {}, "classes": { "values": [ { "class": 0 }, { "class": 1 }, { "class": 2 } ] } }, "confirmation": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "Confirmation", "description": "Represents a confirmation dialog configuration.", "props": [ { "name": "message", "optional": true, "readonly": false, "type": "string", "description": "The message to be displayed in the confirmation dialog." }, { "name": "key", "optional": true, "readonly": false, "type": "string", "description": "A unique key to identify the confirmation dialog." }, { "name": "icon", "optional": true, "readonly": false, "type": "string", "description": "The name of the icon to be displayed in the confirmation dialog." }, { "name": "header", "optional": true, "readonly": false, "type": "string", "description": "The header text of the confirmation dialog." }, { "name": "accept", "optional": true, "readonly": false, "type": "Function", "description": "The callback function to be executed when the accept button is clicked." }, { "name": "reject", "optional": true, "readonly": false, "type": "Function", "description": "The callback function to be executed when the reject button is clicked." }, { "name": "acceptLabel", "optional": true, "readonly": false, "type": "string", "description": "The label text for the accept button." }, { "name": "rejectLabel", "optional": true, "readonly": false, "type": "string", "description": "The label text for the reject button." }, { "name": "acceptIcon", "optional": true, "readonly": false, "type": "string", "description": "The name of the icon to be displayed on the accept button." }, { "name": "rejectIcon", "optional": true, "readonly": false, "type": "string", "description": "The name of the icon to be displayed on the reject button." }, { "name": "acceptVisible", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the accept button should be visible." }, { "name": "rejectVisible", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the reject button should be visible." }, { "name": "blockScroll", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether to block scrolling on the page when the confirmation dialog is displayed." }, { "name": "closeOnEscape", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the confirmation dialog should be closed when the escape key is pressed." }, { "name": "dismissableMask", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether clicking outside the confirmation dialog should dismiss it." }, { "name": "defaultFocus", "optional": true, "readonly": false, "type": "string", "description": "The ID or class name of the element to receive focus by default when the confirmation dialog is opened." }, { "name": "acceptButtonStyleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class name to be applied to the accept button." }, { "name": "rejectButtonStyleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class name to be applied to the reject button." }, { "name": "target", "optional": true, "readonly": false, "type": "EventTarget", "description": "The target event where the confirmation dialog is triggered from." }, { "name": "acceptEvent", "optional": true, "readonly": false, "type": "EventEmitter", "description": "An event emitter for the accept event." }, { "name": "rejectEvent", "optional": true, "readonly": false, "type": "EventEmitter", "description": "An event emitter for the reject event." }, { "name": "acceptButtonProps", "optional": true, "readonly": false, "type": "any", "description": "Accept button properties." }, { "name": "rejectButtonProps", "optional": true, "readonly": false, "type": "any", "description": "Reject button properties." }, { "name": "closeButtonProps", "optional": true, "readonly": false, "type": "any", "description": "Close button properties." }, { "name": "closable", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if the dialog is closable." }, { "name": "position", "optional": true, "readonly": false, "type": "string", "description": "Defines the dialog position." }, { "name": "modal", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the dialog displayed as modal or not." } ] } ] } }, "confirmationservice": { "description": "Defines the service used by the component", "methods": { "description": "Methods used in service.", "values": [ { "name": "confirm", "parameters": [ { "name": "confirmation", "type": "Confirmation", "description": "Represents a confirmation dialog configuration." } ], "returnType": "ConfirmationService", "description": "Callback to invoke on confirm." }, { "name": "close", "parameters": [], "returnType": "ConfirmationService", "description": "Closes the dialog." }, { "name": "onAccept", "parameters": [], "returnType": "void", "description": "Accepts the dialog." } ] } }, "contextmenuservice": { "components": {} }, "filtermatchmode": { "components": {} }, "filtermetadata": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "FilterMetadata", "description": "Represents metadata for filtering a data set.", "props": [ { "name": "value", "optional": true, "readonly": false, "type": "any", "description": "The value used for filtering." }, { "name": "matchMode", "optional": true, "readonly": false, "type": "string", "description": "The match mode for filtering." }, { "name": "operator", "optional": true, "readonly": false, "type": "string", "description": "The operator for filtering." } ] } ] } }, "filteroperator": { "components": {} }, "filterservice": { "components": {} }, "lazyloadevent": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "LazyLoadEvent", "description": "Represents an event object for lazy loading data.", "props": [ { "name": "first", "optional": true, "readonly": false, "type": "number", "description": "The index of the first record to be loaded." }, { "name": "last", "optional": true, "readonly": false, "type": "number", "description": "The index of the last record to be loaded." }, { "name": "rows", "optional": true, "readonly": false, "type": "number", "description": "The number of rows to load." }, { "name": "sortField", "optional": true, "readonly": false, "type": "string", "description": "The field to be used for sorting." }, { "name": "sortOrder", "optional": true, "readonly": false, "type": "number", "description": "The sort order for the field." }, { "name": "multiSortMeta", "optional": true, "readonly": false, "type": "SortMeta[]", "description": "An array of sort metadata objects for multiple column sorting." }, { "name": "filters", "optional": true, "readonly": false, "type": "{ [s: string]: FilterMetadata }", "description": "An object containing filter metadata for filtering the data.\nThe keys represent the field names, and the values represent the corresponding filter metadata." }, { "name": "globalFilter", "optional": true, "readonly": false, "type": "any", "description": "The global filter value for filtering across all columns." }, { "name": "forceUpdate", "optional": true, "readonly": false, "type": "() => void", "description": "A function that can be called to force an update in the lazy loaded data." } ] } ] } }, "lazyloadmeta": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "LazyLoadMeta", "description": "Meta data for lazy load event.", "props": [ { "name": "first", "optional": true, "readonly": false, "type": "number" }, { "name": "rows", "optional": true, "readonly": false, "type": "number" }, { "name": "sortField", "optional": true, "readonly": false, "type": "string | string[]" }, { "name": "sortOrder", "optional": true, "readonly": false, "type": "number" }, { "name": "filters", "optional": true, "readonly": false, "type": "{ [s: string]: FilterMetadata | FilterMetadata[] }" }, { "name": "globalFilter", "optional": true, "readonly": false, "type": "string | string[]" }, { "name": "multiSortMeta", "optional": true, "readonly": false, "type": "SortMeta[]" }, { "name": "forceUpdate", "optional": true, "readonly": false, "type": "Function" }, { "name": "last", "optional": true, "readonly": false, "type": "number" } ] } ] } }, "lifecycle": { "components": {} }, "megamenuitem": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "MegaMenuItem", "description": "MegaMenuItem API provides the following properties.", "props": [ { "name": "label", "optional": true, "readonly": false, "type": "string", "description": "Text of the item." }, { "name": "icon", "optional": true, "readonly": false, "type": "string", "description": "Icon of the item." }, { "name": "command", "optional": true, "readonly": false, "type": "(event?: any) => void", "description": "Callback to execute when item is clicked." }, { "name": "url", "optional": true, "readonly": false, "type": "string", "description": "External link to navigate when item is clicked." }, { "name": "items", "optional": true, "readonly": false, "type": "MenuItem[][]", "description": "An array of children menuitems." }, { "name": "expanded", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the mega menu item is expanded." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "description": "When set as true, disables the menuitem." }, { "name": "visible", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the dom element of menuitem is created or not." }, { "name": "target", "optional": true, "readonly": false, "type": "string", "description": "Specifies where to open the linked document." }, { "name": "routerLinkActiveOptions", "optional": true, "readonly": false, "type": "any", "description": "Configuration for active router link." }, { "name": "separator", "optional": true, "readonly": false, "type": "boolean", "description": "Defines the item as a separator." }, { "name": "badge", "optional": true, "readonly": false, "type": "string", "description": "Value of the badge." }, { "name": "badgeStyleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the badge." }, { "name": "style", "optional": true, "readonly": false, "type": "any", "description": "Inline style of the menuitem." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the menuitem." }, { "name": "iconStyle", "optional": true, "readonly": false, "type": "any", "description": "Inline style of the item's icon." }, { "name": "title", "optional": true, "readonly": false, "type": "string", "description": "Tooltip text of the item." }, { "name": "id", "optional": true, "readonly": false, "type": "string", "description": "Identifier of the element." }, { "name": "automationId", "optional": true, "readonly": false, "type": "any", "description": "Value of HTML data-* attribute." }, { "name": "tabindex", "optional": true, "readonly": false, "type": "string", "description": "Specifies tab order of the item." }, { "name": "routerLink", "optional": true, "readonly": false, "type": "any", "description": "RouterLink definition for internal navigation." }, { "name": "queryParams", "optional": true, "readonly": false, "type": "{ [k: string]: any }", "description": "Query parameters for internal navigation via routerLink." }, { "name": "fragment", "optional": true, "readonly": false, "type": "string", "description": "Sets the hash fragment for the URL." }, { "name": "queryParamsHandling", "optional": true, "readonly": false, "type": "QueryParamsHandling", "description": "How to handle query parameters in the router link for the next navigation. One of:\n merge : Merge new with current parameters.\n preserve : Preserve current parameters.k." }, { "name": "preserveFragment", "optional": true, "readonly": false, "type": "boolean", "description": "When true, preserves the URL fragment for the next navigation." }, { "name": "skipLocationChange", "optional": true, "readonly": false, "type": "boolean", "description": "When true, navigates without pushing a new state into history." }, { "name": "replaceUrl", "optional": true, "readonly": false, "type": "boolean", "description": "When true, navigates while replacing the current state in history." }, { "name": "state", "optional": true, "readonly": false, "type": "{ [k: string]: any }", "description": "Developer-defined state that can be passed to any navigation." } ] } ] } }, "menuitem": { "components": {}, "events": { "description": "Defines the custom events used by the component's emitters.", "values": [ { "name": "MenuItemCommandEvent", "description": "Custom command event", "props": [ { "name": "originalEvent", "optional": true, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "item", "optional": true, "readonly": false, "type": "MenuItem | MegaMenuItem", "description": "Selected menu item." }, { "name": "index", "optional": true, "readonly": false, "type": "number", "description": "Index of the selected item." } ] } ] }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "MenuItem", "description": "MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.", "props": [ { "name": "label", "optional": true, "readonly": false, "type": "string", "description": "Text of the item." }, { "name": "icon", "optional": true, "readonly": false, "type": "string", "description": "Icon of the item." }, { "name": "command", "optional": true, "readonly": false }, { "name": "url", "optional": true, "readonly": false, "type": "string", "description": "External link to navigate when item is clicked." }, { "name": "items", "optional": true, "readonly": false, "type": "MenuItem[]", "description": "An array of children menuitems." }, { "name": "expanded", "optional": true, "readonly": false, "type": "boolean", "description": "Visibility of submenu." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "description": "When set as true, disables the menuitem." }, { "name": "visible", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the dom element of menuitem is created or not." }, { "name": "target", "optional": true, "readonly": false, "type": "string", "description": "Specifies where to open the linked document." }, { "name": "escape", "optional": true, "readonly": false, "type": "boolean", "description": "Whether to escape the label or not. Set to false to display html content." }, { "name": "routerLinkActiveOptions", "optional": true, "readonly": false, "type": "any", "description": "Configuration for active router link." }, { "name": "separator", "optional": true, "readonly": false, "type": "boolean", "description": "Defines the item as a separator." }, { "name": "badge", "optional": true, "readonly": false, "type": "string", "description": "Value of the badge." }, { "name": "tooltip", "optional": true, "readonly": false, "type": "string", "description": "Tooltip of the item." }, { "name": "tooltipPosition", "optional": true, "readonly": false, "type": "string", "description": "Position of the tooltip item." }, { "name": "badgeStyleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the badge." }, { "name": "style", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the menuitem." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the menuitem." }, { "name": "title", "optional": true, "readonly": false, "type": "string", "description": "Tooltip text of the item." }, { "name": "id", "optional": true, "readonly": false, "type": "string", "description": "Identifier of the element." }, { "name": "automationId", "optional": true, "readonly": false, "type": "any", "description": "Value of HTML data-* attribute." }, { "name": "tabindex", "optional": true, "readonly": false, "type": "string", "description": "Specifies tab order of the item." }, { "name": "routerLink", "optional": true, "readonly": false, "type": "any", "description": "RouterLink definition for internal navigation." }, { "name": "queryParams", "optional": true, "readonly": false, "type": "{ [k: string]: any }", "description": "Query parameters for internal navigation via routerLink." }, { "name": "fragment", "optional": true, "readonly": false, "type": "string", "description": "Sets the hash fragment for the URL." }, { "name": "queryParamsHandling", "optional": true, "readonly": false, "type": "QueryParamsHandling", "description": "How to handle query parameters in the router link for the next navigation. One of:\n merge : Merge new with current parameters.\n preserve : Preserve current parameters.k." }, { "name": "preserveFragment", "optional": true, "readonly": false, "type": "boolean", "description": "When true, preserves the URL fragment for the next navigation." }, { "name": "skipLocationChange", "optional": true, "readonly": false, "type": "boolean", "description": "When true, navigates without pushing a new state into history." }, { "name": "replaceUrl", "optional": true, "readonly": false, "type": "boolean", "description": "When true, navigates while replacing the current state in history." }, { "name": "iconStyle", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the item's icon." }, { "name": "iconClass", "optional": true, "readonly": false, "type": "string", "description": "Class of the item's icon." }, { "name": "labelStyle", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the item's label." }, { "name": "labelClass", "optional": true, "readonly": false, "type": "string", "description": "Class of the item's label." }, { "name": "linkStyle", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the item's link." }, { "name": "linkClass", "optional": true, "readonly": false, "type": "string", "description": "Class of the item's link." }, { "name": "state", "optional": true, "readonly": false, "type": "{ [k: string]: any }", "description": "Developer-defined state that can be passed to any navigation." }, { "name": "tooltipOptions", "optional": true, "readonly": false, "type": "TooltipOptions", "description": "Options of the item's tooltip." } ] } ] } }, "messageservice": { "description": "Defines the service used by the component", "methods": { "description": "Methods used in service.", "values": [ { "name": "add", "parameters": [ { "name": "message", "type": "ToastMessageOptions", "description": "Message to be added." } ], "returnType": "void", "description": "Inserts single message." }, { "name": "addAll", "parameters": [ { "name": "messages", "type": "ToastMessageOptions[]", "description": "Messages to be added." } ], "returnType": "void", "description": "Inserts new messages." }, { "name": "clear", "parameters": [ { "name": "key", "type": "string", "description": "Key of the message to be cleared." } ], "returnType": "void", "description": "Clears the message with the given key." } ] } }, "overlayoptions": { "components": {}, "events": { "description": "Defines the custom events used by the component's emitters.", "values": [ { "name": "ResponsiveOverlayOptions", "description": "Represents the options for a responsive overlay.", "props": [ { "name": "style", "optional": true, "readonly": false, "type": "any", "description": "The inline style for the responsive overlay." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class for the responsive overlay." }, { "name": "contentStyle", "optional": true, "readonly": false, "type": "any", "description": "The inline style for the content of the responsive overlay." }, { "name": "contentStyleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class for the content of the responsive overlay." }, { "name": "breakpoint", "optional": true, "readonly": false, "type": "string", "description": "The breakpoint for the responsive overlay." }, { "name": "media", "optional": true, "readonly": false, "type": "string", "description": "The media query for the responsive overlay." }, { "name": "direction", "optional": true, "readonly": false, "type": "ResponsiveOverlayDirectionType", "description": "The direction for the responsive overlay." } ] }, { "name": "OverlayOnShowEvent", "description": "Represents an event that occurs when an overlay is shown.", "props": [ { "name": "overlay", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The overlay element." }, { "name": "target", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The target element." }, { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay." } ] }, { "name": "OverlayOnBeforeShowEvent", "description": "Represents an event that occurs before an overlay is shown.", "props": [ { "name": "overlay", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The overlay element." }, { "name": "target", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The target element." }, { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay." } ] }, { "name": "OverlayOnBeforeHideEvent", "description": "Represents an event that occurs before an overlay is hidden.", "props": [ { "name": "overlay", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The overlay element." }, { "name": "target", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The target element." }, { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay." } ] }, { "name": "OverlayOnHideEvent", "description": "Represents an event that occurs when an overlay is hidden.", "props": [ { "name": "overlay", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The overlay element." }, { "name": "target", "optional": true, "readonly": false, "type": "HTMLElement", "description": "The target element." }, { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay." } ] } ] }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "OverlayListenerOptions", "description": "Represents the options for an overlay listener.", "props": [ { "name": "type", "optional": true, "readonly": false, "type": "\"scroll\" | \"outside\" | \"resize\"", "description": "The type of listener, which can be 'scroll', 'outside', 'resize', or undefined." }, { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay listener." }, { "name": "valid", "optional": true, "readonly": false, "type": "boolean", "description": "Indicates whether the overlay listener is valid." } ] }, { "name": "OverlayOptions", "description": "Represents the options for an overlay.", "props": [ { "name": "mode", "optional": true, "readonly": false, "type": "OverlayModeType", "description": "The mode of the overlay." }, { "name": "style", "optional": true, "readonly": false, "type": "any", "description": "The inline style for the overlay." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class for the overlay." }, { "name": "contentStyle", "optional": true, "readonly": false, "type": "any", "description": "The inline style for the content of the overlay." }, { "name": "contentStyleClass", "optional": true, "readonly": false, "type": "string", "description": "The CSS class for the content of the overlay." }, { "name": "target", "optional": true, "readonly": false, "type": "any", "description": "The target element." }, { "name": "appendTo", "optional": true, "readonly": false, "type": "HTMLElement | \"body\"", "description": "The element or location where the overlay should be appended." }, { "name": "autoZIndex", "optional": true, "readonly": false, "type": "boolean", "description": "Indicates whether the overlay should have an auto-generated z-index." }, { "name": "baseZIndex", "optional": true, "readonly": false, "type": "number", "description": "The base z-index value for the overlay." }, { "name": "showTransitionOptions", "optional": true, "readonly": false, "type": "string", "description": "The transition options for showing the overlay.", "deprecated": "since v21.0.0. Use " }, { "name": "hideTransitionOptions", "optional": true, "readonly": false, "type": "string", "description": "The transition options for hiding the overlay.", "deprecated": "since v21.0.0. Use " }, { "name": "motionOptions", "optional": true, "readonly": false, "type": "MotionOptions", "description": "The motion options for the overlay." }, { "name": "hideOnEscape", "optional": true, "readonly": false, "type": "boolean", "description": "Indicates whether the overlay should be hidden when the escape key is pressed." }, { "name": "listener", "optional": true, "readonly": false, "type": "(event: Event, options?: OverlayListenerOptions) => boolean | void", "description": "A listener function for handling events related to the overlay." }, { "name": "responsive", "optional": true, "readonly": false, "type": "ResponsiveOverlayOptions", "description": "The options for a responsive overlay." }, { "name": "onBeforeShow", "optional": true, "readonly": false, "type": "(event?: OverlayOnBeforeShowEvent) => void", "description": "A callback function that is invoked before the overlay is shown." }, { "name": "onShow", "optional": true, "readonly": false, "type": "(event?: OverlayOnShowEvent) => void", "description": "A callback function that is invoked when the overlay is shown." }, { "name": "onBeforeHide", "optional": true, "readonly": false, "type": "(event?: OverlayOnBeforeHideEvent) => void", "description": "A callback function that is invoked before the overlay is hidden." }, { "name": "onHide", "optional": true, "readonly": false, "type": "(event?: OverlayOnHideEvent) => void", "description": "A callback function that is invoked when the overlay is hidden." }, { "name": "onAnimationStart", "optional": true, "readonly": false, "type": "(event?: AnimationEvent) => void", "description": "A callback function that is invoked when the overlay's animation starts." }, { "name": "onAnimationDone", "optional": true, "readonly": false, "type": "(event?: AnimationEvent) => void", "description": "A callback function that is invoked when the overlay's animation is done." } ] } ] }, "types": { "description": "Defines the custom types used by the module.", "values": [ { "name": "OverlayModeType", "value": "\"modal\" | \"overlay\" | undefined", "description": "Represents the type of overlay mode, which can be 'modal', 'overlay', or undefined." }, { "name": "ResponsiveOverlayDirectionType", "value": "\"center\" | \"top\" | \"top-start\" | \"top-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\" | \"right\" | \"right-start\" | \"right-end\" | undefined", "description": "Represents the type of direction for a responsive overlay, which can be one of the specified values or undefined." } ] } }, "overlayservice": { "components": {} }, "passthrough": { "components": {} }, "api": { "components": {} }, "scrolleroptions": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "ScrollerOptions", "description": "Options for the scroller.", "props": [ { "name": "id", "optional": true, "readonly": false, "type": "string", "description": "Unique identifier of the element." }, { "name": "style", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the component." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the element." }, { "name": "contentStyle", "optional": true, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the content." }, { "name": "contentStyleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the content." }, { "name": "tabindex", "optional": true, "readonly": false, "type": "number", "description": "Index of the element in tabbing order." }, { "name": "items", "optional": true, "readonly": false, "type": "any[]", "description": "An array of objects to display." }, { "name": "itemSize", "optional": true, "readonly": false, "type": "any", "description": "The height/width of item according to orientation." }, { "name": "scrollHeight", "optional": true, "readonly": false, "type": "string", "description": "Height of the scroll viewport." }, { "name": "scrollWidth", "optional": true, "readonly": false, "type": "string", "description": "Width of the scroll viewport." }, { "name": "orientation", "optional": true, "readonly": false, "type": "\"both\" | \"vertical\" | \"horizontal\"", "description": "The orientation of scrollbar." }, { "name": "step", "optional": true, "readonly": false, "type": "number", "description": "Used to specify how many items to load in each load method in lazy mode." }, { "name": "delay", "optional": true, "readonly": false, "type": "number", "description": "Delay in scroll before new data is loaded." }, { "name": "resizeDelay", "optional": true, "readonly": false, "type": "number", "description": "Delay after window's resize finishes." }, { "name": "appendOnly", "optional": true, "readonly": false, "type": "boolean", "description": "Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash." }, { "name": "inline", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies whether the scroller should be displayed inline or not." }, { "name": "lazy", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if data is loaded and interacted with in lazy manner." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "description": "If disabled, the scroller feature is eliminated and the content is displayed directly." }, { "name": "loaderDisabled", "optional": true, "readonly": false, "type": "boolean", "description": "Used to implement a custom loader instead of using the loader feature in the scroller." }, { "name": "columns", "optional": true, "readonly": false, "type": "any[]", "description": "Columns to display." }, { "name": "showSpacer", "optional": true, "readonly": false, "type": "boolean", "description": "Used to implement a custom spacer instead of using the spacer feature in the scroller." }, { "name": "showLoader", "optional": true, "readonly": false, "type": "boolean", "description": "Defines whether to show loader." }, { "name": "numToleratedItems", "optional": true, "readonly": false, "type": "any", "description": "Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view." }, { "name": "loading", "optional": true, "readonly": false, "type": "boolean", "description": "Defines whether the data is loaded." }, { "name": "autoSize", "optional": true, "readonly": false, "type": "boolean", "description": "Defines whether to dynamically change the height or width of scrollable container." }, { "name": "trackBy", "optional": true, "readonly": false, "type": "Function", "description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algoritm checks for object identity." }, { "name": "onLazyLoad", "optional": true, "readonly": false, "type": "Function", "description": "Callback to invoke in lazy mode to load new data." }, { "name": "onScroll", "optional": true, "readonly": false, "type": "Function", "description": "Callback to invoke when scroll position changes." }, { "name": "onScrollIndexChange", "optional": true, "readonly": false, "type": "Function", "description": "Callback to invoke when scroll position and item's range in view changes." } ] } ] } }, "selectitem": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "SelectItem", "description": "Represents an option item.", "props": [ { "name": "label", "optional": true, "readonly": false, "type": "string" }, { "name": "value", "optional": false, "readonly": false, "type": "unknown" }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string" }, { "name": "icon", "optional": true, "readonly": false, "type": "string" }, { "name": "title", "optional": true, "readonly": false, "type": "string" }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean" } ] } ] } }, "selectitemgroup": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "SelectItemGroup", "description": "Represents a group of select items.", "props": [ { "name": "label", "optional": false, "readonly": false, "type": "string" }, { "name": "value", "optional": true, "readonly": false, "type": "any" }, { "name": "items", "optional": false, "readonly": false, "type": "SelectItem[]" } ] } ] } }, "shared": { "components": {} }, "sortevent": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "SortEvent", "description": "Represents an event triggered when sorting is applied.", "props": [ { "name": "data", "optional": true, "readonly": false, "type": "any[]" }, { "name": "mode", "optional": true, "readonly": false, "type": "string" }, { "name": "field", "optional": true, "readonly": false, "type": "string" }, { "name": "order", "optional": true, "readonly": false, "type": "number" }, { "name": "multiSortMeta", "optional": true, "readonly": false, "type": "SortMeta[]" } ] } ] } }, "sortmeta": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "SortMeta", "description": "Represents metadata for sorting.", "props": [ { "name": "field", "optional": false, "readonly": false, "type": "string" }, { "name": "order", "optional": false, "readonly": false, "type": "number" } ] } ] } }, "tablestate": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "TableState", "description": "Represents the state of a table component.", "props": [ { "name": "first", "optional": true, "readonly": false, "type": "number", "description": "The index of the first row to be displayed." }, { "name": "rows", "optional": true, "readonly": false, "type": "number", "description": "The number of rows to be displayed per page." }, { "name": "sortField", "optional": true, "readonly": false, "type": "string", "description": "The field used for sorting." }, { "name": "sortOrder", "optional": true, "readonly": false, "type": "number", "description": "The sort order." }, { "name": "multiSortMeta", "optional": true, "readonly": false, "type": "SortMeta[]", "description": "An array of sort metadata when multiple sorting is applied." }, { "name": "filters", "optional": true, "readonly": false, "type": "{ [s: string]: FilterMetadata | FilterMetadata[] }", "description": "The filters to be applied to the table." }, { "name": "columnWidths", "optional": true, "readonly": false, "type": "string", "description": "The column widths for the table." }, { "name": "tableWidth", "optional": true, "readonly": false, "type": "string", "description": "The width of the table." }, { "name": "wrapperWidth", "optional": true, "readonly": false, "type": "string", "description": "The width of the wrapper element containing the table." }, { "name": "selection", "optional": true, "readonly": false, "type": "any", "description": "The selected item(s) in the table." }, { "name": "columnOrder", "optional": true, "readonly": false, "type": "string[]", "description": "The order of the columns in the table." }, { "name": "expandedRowKeys", "optional": true, "readonly": false, "type": "{ [s: string]: boolean }", "description": "The keys of the expanded rows in the table." } ] } ] } }, "toastmessage": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "ToastMessageOptions", "description": "Deines valid options for the toast message.", "props": [ { "name": "text", "optional": true, "readonly": false, "type": "any" }, { "name": "severity", "optional": true, "readonly": false, "type": "string" }, { "name": "summary", "optional": true, "readonly": false, "type": "string" }, { "name": "detail", "optional": true, "readonly": false, "type": "string" }, { "name": "id", "optional": true, "readonly": false, "type": "any" }, { "name": "key", "optional": true, "readonly": false, "type": "string" }, { "name": "life", "optional": true, "readonly": false, "type": "number" }, { "name": "sticky", "optional": true, "readonly": false, "type": "boolean" }, { "name": "closable", "optional": true, "readonly": false, "type": "boolean" }, { "name": "data", "optional": true, "readonly": false, "type": "any" }, { "name": "icon", "optional": true, "readonly": false, "type": "string" }, { "name": "contentStyleClass", "optional": true, "readonly": false, "type": "string" }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string" }, { "name": "closeIcon", "optional": true, "readonly": false, "type": "string" } ] } ] } }, "tooltipoptions": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "TooltipOptions", "description": "Defines options of Tooltip.", "props": [ { "name": "tooltipLabel", "optional": true, "readonly": false, "type": "string", "description": "Label of tooltip." }, { "name": "tooltipPosition", "optional": true, "readonly": false, "type": "\"right\" | \"left\" | \"top\" | \"bottom\"", "description": "Position of tooltip." }, { "name": "tooltipEvent", "optional": true, "readonly": false, "type": "\"hover\" | \"focus\" | \"both\"", "description": "Event to show the tooltip." }, { "name": "appendTo", "optional": true, "readonly": false, "type": "any", "description": "Target element to attach the overlay, valid values are \"body\" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]=\"mydiv\" for a div element having #mydiv as variable name)." }, { "name": "positionStyle", "optional": true, "readonly": false, "type": "string", "description": "Type of CSS position." }, { "name": "tooltipStyleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the tooltip." }, { "name": "tooltipZIndex", "optional": true, "readonly": false, "type": "string", "description": "Whether the z-index should be managed automatically to always go on top or have a fixed value." }, { "name": "escape", "optional": true, "readonly": false, "type": "boolean", "description": "By default the tooltip contents are rendered as text. Set to false to support html tags in the content." }, { "name": "disabled", "optional": true, "readonly": false, "type": "boolean", "description": "When present, it specifies that the component should be disabled." }, { "name": "positionTop", "optional": true, "readonly": false, "type": "number", "description": "Specifies the additional vertical offset of the tooltip from its default position." }, { "name": "positionLeft", "optional": true, "readonly": false, "type": "number", "description": "Specifies the additional horizontal offset of the tooltip from its default position." }, { "name": "showDelay", "optional": true, "readonly": false, "type": "number", "description": "Delay to show the tooltip in milliseconds." }, { "name": "hideDelay", "optional": true, "readonly": false, "type": "number", "description": "Delay to hide the tooltip in milliseconds." }, { "name": "life", "optional": true, "readonly": false, "type": "number", "description": "Time to wait in milliseconds to hide the tooltip even it is active." }, { "name": "id", "optional": true, "readonly": false, "type": "string", "description": "When present, it adds a custom id to the tooltip." } ] } ] } }, "translation": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "Translation", "description": "Represents a set of translated strings used in a component or application.", "props": [ { "name": "startsWith", "optional": true, "readonly": false, "type": "string" }, { "name": "contains", "optional": true, "readonly": false, "type": "string" }, { "name": "notContains", "optional": true, "readonly": false, "type": "string" }, { "name": "endsWith", "optional": true, "readonly": false, "type": "string" }, { "name": "equals", "optional": true, "readonly": false, "type": "string" }, { "name": "completed", "optional": true, "readonly": false, "type": "string" }, { "name": "notEquals", "optional": true, "readonly": false, "type": "string" }, { "name": "noFilter", "optional": true, "readonly": false, "type": "string" }, { "name": "lt", "optional": true, "readonly": false, "type": "string" }, { "name": "lte", "optional": true, "readonly": false, "type": "string" }, { "name": "gt", "optional": true, "readonly": false, "type": "string" }, { "name": "gte", "optional": true, "readonly": false, "type": "string" }, { "name": "is", "optional": true, "readonly": false, "type": "string" }, { "name": "isNot", "optional": true, "readonly": false, "type": "string" }, { "name": "before", "optional": true, "readonly": false, "type": "string" }, { "name": "after", "optional": true, "readonly": false, "type": "string" }, { "name": "dateIs", "optional": true, "readonly": false, "type": "string" }, { "name": "dateIsNot", "optional": true, "readonly": false, "type": "string" }, { "name": "dateBefore", "optional": true, "readonly": false, "type": "string" }, { "name": "dateAfter", "optional": true, "readonly": false, "type": "string" }, { "name": "clear", "optional": true, "readonly": false, "type": "string" }, { "name": "apply", "optional": true, "readonly": false, "type": "string" }, { "name": "matchAll", "optional": true, "readonly": false, "type": "string" }, { "name": "matchAny", "optional": true, "readonly": false, "type": "string" }, { "name": "addRule", "optional": true, "readonly": false, "type": "string" }, { "name": "removeRule", "optional": true, "readonly": false, "type": "string" }, { "name": "accept", "optional": true, "readonly": false, "type": "string" }, { "name": "reject", "optional": true, "readonly": false, "type": "string" }, { "name": "choose", "optional": true, "readonly": false, "type": "string" }, { "name": "upload", "optional": true, "readonly": false, "type": "string" }, { "name": "cancel", "optional": true, "readonly": false, "type": "string" }, { "name": "fileSizeTypes", "optional": true, "readonly": false, "type": "string[]" }, { "name": "dayNames", "optional": true, "readonly": false, "type": "string[]" }, { "name": "dayNamesShort", "optional": true, "readonly": false, "type": "string[]" }, { "name": "dayNamesMin", "optional": true, "readonly": false, "type": "string[]" }, { "name": "monthNames", "optional": true, "readonly": false, "type": "string[]" }, { "name": "monthNamesShort", "optional": true, "readonly": false, "type": "string[]" }, { "name": "dateFormat", "optional": true, "readonly": false, "type": "string" }, { "name": "firstDayOfWeek", "optional": true, "readonly": false, "type": "number" }, { "name": "today", "optional": true, "readonly": false, "type": "string" }, { "name": "weekHeader", "optional": true, "readonly": false, "type": "string" }, { "name": "weak", "optional": true, "readonly": false, "type": "string" }, { "name": "medium", "optional": true, "readonly": false, "type": "string" }, { "name": "strong", "optional": true, "readonly": false, "type": "string" }, { "name": "passwordPrompt", "optional": true, "readonly": false, "type": "string" }, { "name": "emptyMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "emptyFilterMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "fileChosenMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "noFileChosenMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "pending", "optional": true, "readonly": false, "type": "string" }, { "name": "chooseYear", "optional": true, "readonly": false, "type": "string" }, { "name": "chooseMonth", "optional": true, "readonly": false, "type": "string" }, { "name": "chooseDate", "optional": true, "readonly": false, "type": "string" }, { "name": "prevDecade", "optional": true, "readonly": false, "type": "string" }, { "name": "nextDecade", "optional": true, "readonly": false, "type": "string" }, { "name": "prevYear", "optional": true, "readonly": false, "type": "string" }, { "name": "nextYear", "optional": true, "readonly": false, "type": "string" }, { "name": "prevMonth", "optional": true, "readonly": false, "type": "string" }, { "name": "nextMonth", "optional": true, "readonly": false, "type": "string" }, { "name": "prevHour", "optional": true, "readonly": false, "type": "string" }, { "name": "nextHour", "optional": true, "readonly": false, "type": "string" }, { "name": "prevMinute", "optional": true, "readonly": false, "type": "string" }, { "name": "nextMinute", "optional": true, "readonly": false, "type": "string" }, { "name": "prevSecond", "optional": true, "readonly": false, "type": "string" }, { "name": "nextSecond", "optional": true, "readonly": false, "type": "string" }, { "name": "am", "optional": true, "readonly": false, "type": "string" }, { "name": "pm", "optional": true, "readonly": false, "type": "string" }, { "name": "searchMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "selectionMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "emptySelectionMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "emptySearchMessage", "optional": true, "readonly": false, "type": "string" }, { "name": "aria", "optional": true, "readonly": false, "type": "Aria" } ] }, { "name": "Aria", "description": "Represents a set of translated HTML attributes used in a component or application.", "props": [ { "name": "trueLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "falseLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "nullLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "star", "optional": true, "readonly": false, "type": "string" }, { "name": "stars", "optional": true, "readonly": false, "type": "string" }, { "name": "selectAll", "optional": true, "readonly": false, "type": "string" }, { "name": "unselectAll", "optional": true, "readonly": false, "type": "string" }, { "name": "close", "optional": true, "readonly": false, "type": "string" }, { "name": "previous", "optional": true, "readonly": false, "type": "string" }, { "name": "next", "optional": true, "readonly": false, "type": "string" }, { "name": "navigation", "optional": true, "readonly": false, "type": "string" }, { "name": "scrollTop", "optional": true, "readonly": false, "type": "string" }, { "name": "moveTop", "optional": true, "readonly": false, "type": "string" }, { "name": "moveUp", "optional": true, "readonly": false, "type": "string" }, { "name": "moveDown", "optional": true, "readonly": false, "type": "string" }, { "name": "moveBottom", "optional": true, "readonly": false, "type": "string" }, { "name": "moveToTarget", "optional": true, "readonly": false, "type": "string" }, { "name": "moveToSource", "optional": true, "readonly": false, "type": "string" }, { "name": "moveAllToTarget", "optional": true, "readonly": false, "type": "string" }, { "name": "moveAllToSource", "optional": true, "readonly": false, "type": "string" }, { "name": "pageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "firstPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "lastPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "nextPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "prevPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "rowsPerPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "previousPageLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "jumpToPageDropdownLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "jumpToPageInputLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "selectRow", "optional": true, "readonly": false, "type": "string" }, { "name": "unselectRow", "optional": true, "readonly": false, "type": "string" }, { "name": "expandRow", "optional": true, "readonly": false, "type": "string" }, { "name": "collapseRow", "optional": true, "readonly": false, "type": "string" }, { "name": "showFilterMenu", "optional": true, "readonly": false, "type": "string" }, { "name": "hideFilterMenu", "optional": true, "readonly": false, "type": "string" }, { "name": "filterOperator", "optional": true, "readonly": false, "type": "string" }, { "name": "filterConstraint", "optional": true, "readonly": false, "type": "string" }, { "name": "editRow", "optional": true, "readonly": false, "type": "string" }, { "name": "saveEdit", "optional": true, "readonly": false, "type": "string" }, { "name": "cancelEdit", "optional": true, "readonly": false, "type": "string" }, { "name": "listView", "optional": true, "readonly": false, "type": "string" }, { "name": "gridView", "optional": true, "readonly": false, "type": "string" }, { "name": "slide", "optional": true, "readonly": false, "type": "string" }, { "name": "slideNumber", "optional": true, "readonly": false, "type": "string" }, { "name": "zoomImage", "optional": true, "readonly": false, "type": "string" }, { "name": "zoomIn", "optional": true, "readonly": false, "type": "string" }, { "name": "zoomOut", "optional": true, "readonly": false, "type": "string" }, { "name": "rotateRight", "optional": true, "readonly": false, "type": "string" }, { "name": "rotateLeft", "optional": true, "readonly": false, "type": "string" }, { "name": "listLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "selectColor", "optional": true, "readonly": false, "type": "string" }, { "name": "removeLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "browseFiles", "optional": true, "readonly": false, "type": "string" }, { "name": "maximizeLabel", "optional": true, "readonly": false, "type": "string" }, { "name": "minimizeLabel", "optional": true, "readonly": false, "type": "string" } ] } ] } }, "translationkeys": { "components": {} }, "treedragdropservice": { "components": {} }, "treenode": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "TreeNode", "description": "Represents a node in a tree data structure.", "props": [ { "name": "checked", "optional": true, "readonly": false, "type": "boolean" }, { "name": "label", "optional": true, "readonly": false, "type": "string", "description": "Label of the node." }, { "name": "data", "optional": true, "readonly": false, "type": "unknown", "description": "Data represented by the node." }, { "name": "icon", "optional": true, "readonly": false, "type": "string", "description": "Icon of the node to display next to content." }, { "name": "expandedIcon", "optional": true, "readonly": false, "type": "string", "description": "Icon to use in expanded state." }, { "name": "collapsedIcon", "optional": true, "readonly": false, "type": "string", "description": "Icon to use in collapsed state." }, { "name": "children", "optional": true, "readonly": false, "type": "TreeNode[]", "description": "An array of treenodes as children." }, { "name": "leaf", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies if the node has children. Used in lazy loading." }, { "name": "expanded", "optional": true, "readonly": false, "type": "boolean", "description": "Expanded state of the node." }, { "name": "type", "optional": true, "readonly": false, "type": "string", "description": "Type of the node to match a template." }, { "name": "parent", "optional": true, "readonly": false, "type": "TreeNode", "description": "Parent of the node." }, { "name": "partialSelected", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if value is partially selected." }, { "name": "style", "optional": true, "readonly": false, "type": "any", "description": "Inline style of the node." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the node." }, { "name": "draggable", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if the node is draggable." }, { "name": "droppable", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if the node is droppable." }, { "name": "selectable", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the node is selectable when selection mode is enabled." }, { "name": "key", "optional": true, "readonly": false, "type": "string", "description": "Mandatory unique key of the node." }, { "name": "loading", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the node is loading. Used in lazy loading." } ] } ] } }, "treenodedragevent": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "TreeNodeDragEvent", "description": "Represents the event data for a tree node drag operation.", "props": [ { "name": "tree", "optional": true, "readonly": false, "type": "any", "description": "Tree instance." }, { "name": "node", "optional": true, "readonly": false, "type": "TreeNode", "description": "Node to be dragged." }, { "name": "subNodes", "optional": true, "readonly": false, "type": "TreeNode[]", "description": "Child nodes of dragged node." }, { "name": "index", "optional": true, "readonly": false, "type": "number", "description": "Index of dragged node." }, { "name": "scope", "optional": true, "readonly": false, "type": "any", "description": "Scope of dragged node." } ] } ] } }, "treetablenode": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "TreeTableNode", "description": "Tree table node element.", "props": [ { "name": "checked", "optional": true, "readonly": false, "type": "boolean" }, { "name": "label", "optional": true, "readonly": false, "type": "string", "description": "Label of the node." }, { "name": "data", "optional": true, "readonly": false, "type": "any", "description": "Data represented by the node." }, { "name": "icon", "optional": true, "readonly": false, "type": "string", "description": "Icon of the node to display next to content." }, { "name": "expandedIcon", "optional": true, "readonly": false, "type": "string", "description": "Icon to use in expanded state." }, { "name": "collapsedIcon", "optional": true, "readonly": false, "type": "string", "description": "Icon to use in collapsed state." }, { "name": "children", "optional": true, "readonly": false, "type": "TreeNode[]", "description": "An array of treenodes as children." }, { "name": "leaf", "optional": true, "readonly": false, "type": "boolean", "description": "Specifies if the node has children. Used in lazy loading." }, { "name": "expanded", "optional": true, "readonly": false, "type": "boolean", "description": "Expanded state of the node." }, { "name": "parent", "optional": true, "readonly": false, "type": "TreeNode", "description": "Parent of the node." }, { "name": "partialSelected", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if value is partially selected." }, { "name": "style", "optional": true, "readonly": false, "type": "any", "description": "Inline style of the node." }, { "name": "styleClass", "optional": true, "readonly": false, "type": "string", "description": "Style class of the node." }, { "name": "draggable", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if the node is draggable." }, { "name": "droppable", "optional": true, "readonly": false, "type": "boolean", "description": "Defines if the node is droppable." }, { "name": "selectable", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the node is selectable when selection mode is enabled." }, { "name": "key", "optional": true, "readonly": false, "type": "string", "description": "Mandatory unique key of the node." }, { "name": "loading", "optional": true, "readonly": false, "type": "boolean", "description": "Whether the node is loading. Used in lazy loading." }, { "name": "originalEvent", "optional": true, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "rowNode", "optional": true, "readonly": false, "type": "any", "description": "Row of the node." }, { "name": "node", "optional": true, "readonly": false, "type": "TreeNode", "description": "Node instance." }, { "name": "type", "optional": true, "readonly": false, "type": "string", "description": "Selection type." }, { "name": "index", "optional": true, "readonly": false, "type": "number", "description": "Node index." }, { "name": "level", "optional": true, "readonly": false, "type": "number", "description": "Node level." }, { "name": "visible", "optional": true, "readonly": false, "type": "boolean", "description": "Boolean value indicates if node is in viewport." } ] } ] } }, "autocomplete": { "components": { "AutoComplete": { "description": "AutoComplete is an input component that provides real-time suggestions when being typed.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "minLength", "optional": false, "readonly": false, "type": "number", "default": "1", "description": "Minimum number of characters to initiate a search.", "deprecated": "since v20.0.0, use " }, { "name": "minQueryLength", "optional": false, "readonly": false, "type": "number", "description": "Minimum number of characters to initiate a search." }, { "name": "delay", "optional": false, "readonly": false, "type": "number", "default": "300", "description": "Delay between keystrokes to wait before sending a query." }, { "name": "panelStyle", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the overlay panel element." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Style class of the component.", "deprecated": "since v20.0.0, use " }, { "name": "panelStyleClass", "optional": false, "readonly": false, "type": "string", "description": "Style class of the overlay panel element." }, { "name": "inputStyle", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the input field." }, { "name": "inputId", "optional": false, "readonly": false, "type": "string", "description": "Identifier of the focus input to match a label defined for the component." }, { "name": "inputStyleClass", "optional": false, "readonly": false, "type": "string", "description": "Inline style of the input field." }, { "name": "placeholder", "optional": false, "readonly": false, "type": "string", "description": "Hint text for the input field." }, { "name": "readonly", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When present, it specifies that the input cannot be typed." }, { "name": "scrollHeight", "optional": false, "readonly": false, "type": "string", "default": "200px", "description": "Maximum height of the suggestions panel." }, { "name": "lazy", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Defines if data is loaded and interacted with in lazy manner." }, { "name": "virtualScroll", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether the data should be loaded on demand during scroll." }, { "name": "virtualScrollItemSize", "optional": false, "readonly": false, "type": "number", "description": "Height of an item in the list for VirtualScrolling." }, { "name": "virtualScrollOptions", "optional": false, "readonly": false, "type": "ScrollerOptions", "description": "Whether to use the scroller feature. The properties of scroller component can be used like an object in it." }, { "name": "autoHighlight", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, highlights the first item in the list by default." }, { "name": "forceSelection", "optional": false, "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": "type", "optional": false, "readonly": false, "type": "string", "default": "text", "description": "Type of the input, defaults to \"text\"." }, { "name": "autoZIndex", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": false, "readonly": false, "type": "number", "default": "0", "description": "Base zIndex value to use in layering." }, { "name": "ariaLabel", "optional": false, "readonly": false, "type": "string", "description": "Defines a string that labels the input for accessibility." }, { "name": "dropdownAriaLabel", "optional": false, "readonly": false, "type": "string", "description": "Defines a string that labels the dropdown button for accessibility." }, { "name": "ariaLabelledBy", "optional": false, "readonly": false, "type": "string", "description": "Specifies one or more IDs in the DOM that labels the input field." }, { "name": "dropdownIcon", "optional": false, "readonly": false, "type": "string", "description": "Icon class of the dropdown icon." }, { "name": "unique", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "Ensures uniqueness of selected items on multiple mode." }, { "name": "group", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether to display options as grouped when nested options are provided." }, { "name": "completeOnFocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether to run a query when input receives focus." }, { "name": "showClear", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, a clear icon is displayed to clear the value." }, { "name": "dropdown", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Displays a button next to the input field when enabled." }, { "name": "showEmptyMessage", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "Whether to show the empty message or not." }, { "name": "dropdownMode", "optional": false, "readonly": false, "type": "string", "default": "blank", "description": "Specifies the behavior dropdown button. Default \"blank\" mode sends an empty string and \"current\" mode sends the input value." }, { "name": "multiple", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Specifies if multiple values can be selected." }, { "name": "addOnTab", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, the input value is added to the selected items on tab key press when multiple is true and typeahead is false." }, { "name": "tabindex", "optional": false, "readonly": false, "type": "number", "description": "Index of the element in tabbing order." }, { "name": "dataKey", "optional": false, "readonly": false, "type": "string", "description": "A property to uniquely identify a value in options." }, { "name": "emptyMessage", "optional": false, "readonly": false, "type": "string", "description": "Text to display when there is no data. Defaults to global value in i18n translation configuration." }, { "name": "showTransitionOptions", "optional": false, "readonly": false, "type": "string", "default": ".12s cubic-bezier(0, 0, 0.2, 1)", "description": "Transition options of the show animation.", "deprecated": "since v21.0.0, use " }, { "name": "hideTransitionOptions", "optional": false, "readonly": false, "type": "string", "default": ".1s linear", "description": "Transition options of the hide animation.", "deprecated": "since v21.0.0, use " }, { "name": "autofocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When present, it specifies that the component should automatically get focus on load." }, { "name": "autocomplete", "optional": false, "readonly": false, "type": "string", "default": "off", "description": "Used to define a string that autocomplete attribute the current element." }, { "name": "optionGroupChildren", "optional": false, "readonly": false, "type": "string", "default": "items", "description": "Name of the options field of an option group." }, { "name": "optionGroupLabel", "optional": false, "readonly": false, "type": "string", "default": "label", "description": "Name of the label field of an option group." }, { "name": "overlayOptions", "optional": false, "readonly": false, "type": "OverlayOptions", "description": "Options for the overlay element." }, { "name": "suggestions", "optional": false, "readonly": false, "type": "any[]", "description": "An array of suggestions to display." }, { "name": "optionLabel", "optional": false, "readonly": false, "type": "string | ((item: any) => string)", "description": "Property name or getter function to use as the label of an option." }, { "name": "optionValue", "optional": false, "readonly": false, "type": "string | ((item: any) => string)", "description": "Property name or getter function to use as the value of an option." }, { "name": "id", "optional": false, "readonly": false, "type": "string", "description": "Unique identifier of the component." }, { "name": "searchMessage", "optional": false, "readonly": false, "type": "string", "default": "'{0} results are available'", "description": "Text to display when the search is active. Defaults to global value in i18n translation configuration." }, { "name": "emptySelectionMessage", "optional": false, "readonly": false, "type": "string", "default": "'No selected item'", "description": "Text to display when filtering does not return any results. Defaults to global value in i18n translation configuration." }, { "name": "selectionMessage", "optional": false, "readonly": false, "type": "string", "default": "'{0} items selected'", "description": "Text to be displayed in hidden accessible field when options are selected. Defaults to global value in i18n translation configuration." }, { "name": "autoOptionFocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether to focus on the first visible or selected element when the overlay panel is shown." }, { "name": "selectOnFocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When enabled, the focused option is selected." }, { "name": "searchLocale", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Locale to use in searching. The default locale is the host environment's current locale." }, { "name": "optionDisabled", "optional": false, "readonly": false, "type": "string | ((item: any) => string)", "description": "Property name or getter function to use as the disabled flag of an option, defaults to false when not defined." }, { "name": "focusOnHover", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "When enabled, the hovered option will be focused." }, { "name": "typeahead", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "Whether typeahead is active or not." }, { "name": "addOnBlur", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether to add an item on blur event if the input has value and typeahead is false with multiple mode." }, { "name": "separator", "optional": false, "readonly": false, "type": "string | RegExp", "description": "Separator char to add item when typeahead is false and multiple mode is enabled." }, { "name": "appendTo", "optional": false, "readonly": false, "type": "InputSignal", "default": "'self'", "description": "Target element to attach the overlay, valid values are \"body\" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]=\"mydiv\" for a div element having #mydiv as variable name)." }, { "name": "motionOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "...", "description": "The motion options." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "required", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "There must be a value (if set)." }, { "name": "invalid", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "When present, it specifies that the component should have invalid state style." }, { "name": "disabled", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "When present, it specifies that the component should have disabled state style." }, { "name": "name", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "When present, it specifies that the name of the input." }, { "name": "fluid", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "false", "description": "Spans 100% width of the container when enabled." }, { "name": "variant", "optional": false, "readonly": false, "type": "InputSignal<\"outlined\" | \"filled\">", "default": "'outlined'", "description": "Specifies the input variant of the component." }, { "name": "size", "optional": false, "readonly": false, "type": "InputSignal<\"small\" | \"large\">", "default": "undefined", "description": "Specifies the size of the component." }, { "name": "inputSize", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Specifies the visible width of the input element in characters." }, { "name": "pattern", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Specifies the value must match the pattern." }, { "name": "min", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "The value must be greater than or equal to the value." }, { "name": "max", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "The value must be less than or equal to the value." }, { "name": "step", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Unless the step is set to the any literal, the value must be min + an integral multiple of the step." }, { "name": "minlength", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "The number of characters (code points) must not be less than the value of the attribute, if non-empty." }, { "name": "maxlength", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "The number of characters (code points) must not exceed the value of the attribute." } ] }, "emits": { "description": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "values": [ { "name": "completeMethod", "parameters": [ { "name": "event", "type": "AutoCompleteCompleteEvent" } ], "description": "Callback to invoke to search for suggestions." }, { "name": "onSelect", "parameters": [ { "name": "event", "type": "AutoCompleteSelectEvent" } ], "description": "Callback to invoke when a suggestion is selected." }, { "name": "onUnselect", "parameters": [ { "name": "event", "type": "AutoCompleteUnselectEvent" } ], "description": "Callback to invoke when a selected value is removed." }, { "name": "onAdd", "parameters": [ { "name": "event", "type": "AutoCompleteAddEvent" } ], "description": "Callback to invoke when an item is added via addOnBlur or separator features." }, { "name": "onFocus", "parameters": [ { "name": "event", "type": "Event" } ], "description": "Callback to invoke when the component receives focus." }, { "name": "onBlur", "parameters": [ { "name": "event", "type": "Event" } ], "description": "Callback to invoke when the component loses focus." }, { "name": "onDropdownClick", "parameters": [ { "name": "event", "type": "AutoCompleteDropdownClickEvent" } ], "description": "Callback to invoke to when dropdown button is clicked." }, { "name": "onClear", "parameters": [ { "name": "event", "type": "Event" } ], "description": "Callback to invoke when clear button is clicked." }, { "name": "onInputKeydown", "parameters": [ { "name": "event", "type": "KeyboardEvent" } ], "description": "Callback to invoke on input key down." }, { "name": "onKeyUp", "parameters": [ { "name": "event", "type": "KeyboardEvent" } ], "description": "Callback to invoke on input key up." }, { "name": "onShow", "parameters": [ { "name": "event", "type": "Event" } ], "description": "Callback to invoke on overlay is shown." }, { "name": "onHide", "parameters": [ { "name": "event", "type": "Event" } ], "description": "Callback to invoke on overlay is hidden." }, { "name": "onLazyLoad", "parameters": [ { "name": "event", "type": "AutoCompleteLazyLoadEvent" } ], "description": "Callback to invoke on lazy load data." } ] }, "templates": { "description": "Defines the templates used by the component.", "values": [ { "name": "item", "description": "Custom item template.", "type": "TemplateRef>", "parameters": [] }, { "name": "empty", "description": "Custom empty message template.", "type": "TemplateRef", "parameters": [] }, { "name": "header", "description": "Custom header template.", "type": "TemplateRef", "parameters": [] }, { "name": "footer", "description": "Custom footer template.", "type": "TemplateRef", "parameters": [] }, { "name": "selecteditem", "description": "Custom selected item template.", "type": "TemplateRef>", "parameters": [] }, { "name": "group", "description": "Custom group template.", "type": "TemplateRef>", "parameters": [] }, { "name": "loader", "description": "Custom loader template.", "type": "TemplateRef", "parameters": [] }, { "name": "removeicon", "description": "Custom remove icon template.", "type": "TemplateRef", "parameters": [] }, { "name": "loadingicon", "description": "Custom loading icon template.", "type": "TemplateRef", "parameters": [] }, { "name": "clearicon", "description": "Custom clear icon template.", "type": "TemplateRef", "parameters": [] }, { "name": "dropdownicon", "description": "Custom dropdown icon template.", "type": "TemplateRef", "parameters": [] } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-autocomplete", "description": "Class name of the root element" }, { "class": "p-autocomplete-input", "description": "Class name of the input element" }, { "class": "p-autocomplete-input-multiple", "description": "Class name of the input multiple element" }, { "class": "p-autocomplete-chip-item", "description": "Class name of the chip item element" }, { "class": "p-autocomplete-chip", "description": "Class name of the chip element" }, { "class": "p-autocomplete-chip-icon", "description": "Class name of the chip icon element" }, { "class": "p-autocomplete-input-chip", "description": "Class name of the input chip element" }, { "class": "p-autocomplete-loader", "description": "Class name of the loader element" }, { "class": "p-autocomplete-dropdown", "description": "Class name of the dropdown element" }, { "class": "p-autocomplete-overlay", "description": "Class name of the panel element" }, { "class": "p-autocomplete-list", "description": "Class name of the list element" }, { "class": "p-autocomplete-option-group", "description": "Class name of the option group element" }, { "class": "p-autocomplete-option", "description": "Class name of the option element" }, { "class": "p-autocomplete-empty-message", "description": "Class name of the empty message element" }, { "class": "p-autocomplete-clear-icon", "description": "Class name of the clear icon" } ] } }, "types": { "components": {}, "events": { "description": "Defines the custom events used by the component's emitters.", "values": [ { "name": "AutoCompleteCompleteEvent", "description": "Custom complete event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "query", "optional": false, "readonly": false, "type": "string", "description": "Selected option value." } ] }, { "name": "AutoCompleteDropdownClickEvent", "description": "Custom click event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "query", "optional": true, "readonly": false, "type": "string", "description": "Selected option value." } ] }, { "name": "AutoCompleteSelectEvent", "description": "Custom select event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "value", "optional": false, "readonly": false, "type": "any", "description": "Selected value." } ] }, { "name": "AutoCompleteUnselectEvent", "description": "Custom unselect event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "value", "optional": false, "readonly": false, "type": "any", "description": "Removed value." } ] }, { "name": "AutoCompleteAddEvent", "description": "Custom add event.", "props": [ { "name": "originalEvent", "optional": false, "readonly": false, "type": "Event", "description": "Browser event." }, { "name": "value", "optional": false, "readonly": false, "type": "any", "description": "Added value." } ] }, { "name": "AutoCompleteLazyLoadEvent", "description": "Custom lazy load event.", "props": [ { "name": "first", "optional": false, "readonly": false, "type": "any", "description": "First element in viewport." }, { "name": "last", "optional": false, "readonly": false, "type": "any", "description": "Last element in viewport." } ] } ] }, "templates": { "description": "Defines the templates used by the component.", "values": [ { "parent": "types", "name": "item", "parameters": [ { "name": "context", "type": "AutoCompleteItemTemplateContext", "description": "option data." } ], "description": "Custom item template." }, { "parent": "types", "name": "group", "parameters": [ { "name": "context", "type": "AutoCompleteGroupTemplateContext", "description": "group data." } ], "description": "Custom group template." }, { "parent": "types", "name": "selecteditem", "parameters": [ { "name": "context", "type": "AutoCompleteSelectedItemTemplateContext", "description": "selected item data." } ], "description": "Custom selected item template, only supported in multiple mode." }, { "parent": "types", "name": "header", "parameters": [], "description": "Custom header template." }, { "parent": "types", "name": "empty", "parameters": [], "description": "Custom empty template." }, { "parent": "types", "name": "footer", "parameters": [], "description": "Custom footer template." }, { "parent": "types", "name": "loader", "parameters": [ { "name": "context", "type": "AutoCompleteLoaderTemplateContext", "description": "scroller options." } ], "description": "Custom loader template." }, { "parent": "types", "name": "removeicon", "parameters": [ { "name": "context", "type": "AutoCompleteRemoveIconTemplateContext", "description": "icon context." } ], "description": "Custom remove icon template." }, { "parent": "types", "name": "loadingicon", "parameters": [], "description": "Custom loading icon template." }, { "parent": "types", "name": "clearicon", "parameters": [], "description": "Custom clear icon template." }, { "parent": "types", "name": "dropdownicon", "parameters": [], "description": "Custom dropdown icon template." } ] }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "AutoCompletePassThroughOptions", "description": "Custom pass-through(pt) options.", "props": [ { "name": "host", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the host's DOM element." }, { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." }, { "name": "pcInputText", "optional": true, "readonly": false, "type": "InputTextPassThrough", "description": "Used to pass attributes to the InputText component." }, { "name": "inputMultiple", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the input multiple's DOM element." }, { "name": "chipItem", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the chip item's DOM element." }, { "name": "pcChip", "optional": true, "readonly": false, "type": "ChipPassThrough", "description": "Used to pass attributes to the Chip component." }, { "name": "chipIcon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the chip icon's DOM element." }, { "name": "inputChip", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the input chip's DOM element." }, { "name": "clearIcon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the clear icon's DOM element." }, { "name": "loader", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the loader's DOM element." }, { "name": "dropdown", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the dropdown button's DOM element." }, { "name": "pcOverlay", "optional": true, "readonly": false, "type": "OverlayPassThrough", "description": "Used to pass attributes to the Overlay component." }, { "name": "overlay", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the overlay's DOM element." }, { "name": "listContainer", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the list container's DOM element." }, { "name": "pcScroller", "optional": true, "readonly": false, "type": "VirtualScrollerPassThrough", "description": "Used to pass attributes to the Scroller component." }, { "name": "list", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the list's DOM element." }, { "name": "optionGroup", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the option group's DOM element." }, { "name": "option", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the option's DOM element." }, { "name": "emptyMessage", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the empty message's DOM element." } ] }, { "name": "AutoCompleteItemTemplateContext", "description": "Custom item template context.", "props": [ { "name": "$implicit", "optional": false, "readonly": false, "type": "unknown", "description": "Data of the option." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "description": "Index of the option." } ] }, { "name": "AutoCompleteGroupTemplateContext", "description": "Custom group template context.", "props": [ { "name": "$implicit", "optional": false, "readonly": false, "type": "unknown", "description": "Group option." } ] }, { "name": "AutoCompleteSelectedItemTemplateContext", "description": "Custom selected item template context.", "props": [ { "name": "$implicit", "optional": false, "readonly": false, "type": "unknown", "description": "Selected option value." } ] }, { "name": "AutoCompleteLoaderTemplateContext", "description": "Custom loader template context.", "props": [ { "name": "options", "optional": false, "readonly": false, "type": "ScrollerOptions", "description": "Virtual scroller options." } ] }, { "name": "AutoCompleteRemoveIconTemplateContext", "description": "Custom remove icon template context.", "props": [ { "name": "class", "optional": false, "readonly": false, "type": "string", "description": "Style class of the icon." }, { "name": "removeCallback", "optional": false, "readonly": false, "type": "(event: Event, index: number) => void", "description": "Callback to remove the item." }, { "name": "index", "optional": false, "readonly": false, "type": "number", "description": "Index of the item." } ] } ] } } }, "autofocus": { "components": { "AutoFocus": { "description": "AutoFocus manages focus on focusable element on load.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "autofocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When present, it specifies that the component should automatically get focus on load." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } } } }, "avatar": { "components": { "Avatar": { "description": "Avatar represents people using icons, labels and images.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "label", "optional": false, "readonly": false, "type": "string", "description": "Defines the text to display." }, { "name": "icon", "optional": false, "readonly": false, "type": "string", "description": "Defines the icon to display." }, { "name": "image", "optional": false, "readonly": false, "type": "string", "description": "Defines the image to display." }, { "name": "size", "optional": false, "readonly": false, "type": "\"large\" | \"xlarge\" | \"normal\"", "default": "normal", "description": "Size of the element." }, { "name": "shape", "optional": false, "readonly": false, "type": "\"circle\" | \"square\"", "default": "square", "description": "Shape of the element." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Class of the element.", "deprecated": "since v20.0.0, use " }, { "name": "ariaLabel", "optional": false, "readonly": false, "type": "string", "description": "Establishes a string value that labels the component." }, { "name": "ariaLabelledBy", "optional": false, "readonly": false, "type": "string", "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] }, "emits": { "description": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "values": [ { "name": "onImageError", "parameters": [ { "name": "event", "type": "Event" } ], "description": "This event is triggered if an error occurs while loading an image file." } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-avatar", "description": "Class name of the root element" }, { "class": "p-avatar-label", "description": "Class name of the label element" }, { "class": "p-avatar-icon", "description": "Class name of the icon element" }, { "class": "p-avatar-image", "description": "Container element in image mode" }, { "class": "p-avatar-circle", "description": "Container element with a circle shape" }, { "class": "p-avatar-lg", "description": "Container element with a large size" }, { "class": "p-avatar-xl", "description": "Container element with an xlarge size" } ] } }, "types": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "AvatarPassThroughOptions", "description": "Custom pass-through(pt) options.", "props": [ { "name": "host", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the host's DOM element." }, { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." }, { "name": "label", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the label's DOM element." }, { "name": "icon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the icon's DOM element." }, { "name": "image", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the image's DOM element." } ] } ] } } }, "avatargroup": { "components": { "AvatarGroup": { "description": "AvatarGroup is a helper component for Avatar.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Style class of the component" }, { "name": "style", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the component." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-avatar-group" } ] } }, "types": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "AvatarGroupPassThroughOptions", "description": "Custom pass-through(pt) options.", "props": [ { "name": "host", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the host's DOM element." }, { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." } ] } ] } } }, "badge": { "components": { "BadgeDirective": { "description": "Badge Directive is directive usage of badge component.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "ptBadgeDirective", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the Badge component.", "deprecated": "use pBadgePT instead." }, { "name": "pBadgePT", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the Badge component." }, { "name": "pBadgeUnstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "disabled", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When specified, disables the component." }, { "name": "badgeSize", "optional": false, "readonly": false, "type": "\"small\" | \"large\" | \"xlarge\"", "description": "Size of the badge, valid options are \"large\" and \"xlarge\"." }, { "name": "size", "optional": false, "readonly": false, "type": "\"small\" | \"large\" | \"xlarge\"", "description": "Size of the badge, valid options are \"large\" and \"xlarge\".", "deprecated": "use badgeSize instead." }, { "name": "severity", "optional": false, "readonly": false, "type": "\"success\" | \"info\" | \"warn\" | \"danger\" | \"secondary\" | \"contrast\"", "description": "Severity type of the badge." }, { "name": "value", "optional": false, "readonly": false, "type": "string | number", "description": "Value to display inside the badge." }, { "name": "badgeStyle", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the element." }, { "name": "badgeStyleClass", "optional": false, "readonly": false, "type": "string", "description": "Class of the element." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } }, "Badge": { "description": "Badge is a small status indicator for another element.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "styleClass", "optional": false, "readonly": false, "type": "InputSignal", "default": "...", "description": "Class of the element.", "deprecated": "since v20.0.0, use " }, { "name": "badgeSize", "optional": false, "readonly": false, "type": "InputSignal<\"small\" | \"large\" | \"xlarge\">", "default": "...", "description": "Size of the badge, valid options are \"large\" and \"xlarge\"." }, { "name": "size", "optional": false, "readonly": false, "type": "InputSignal<\"small\" | \"large\" | \"xlarge\">", "default": "...", "description": "Size of the badge, valid options are \"large\" and \"xlarge\"." }, { "name": "severity", "optional": false, "readonly": false, "type": "InputSignal<\"success\" | \"info\" | \"warn\" | \"danger\" | \"secondary\" | \"contrast\">", "default": "...", "description": "Severity type of the badge." }, { "name": "value", "optional": false, "readonly": false, "type": "InputSignal", "default": "...", "description": "Value to display inside the badge." }, { "name": "badgeDisabled", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "...", "description": "When specified, disables the component." }, { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-badge", "description": "Class name of the root element" } ] } }, "types": { "components": {}, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "BadgePassThroughOptions", "description": "Custom passthrough(pt) options.", "props": [ { "name": "host", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the host's DOM element." }, { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." } ] } ] } } }, "base": { "components": {}, "style": { "components": {} } }, "basecomponent": { "components": {}, "style": { "components": {} } }, "baseeditableholder": { "components": {} }, "baseinput": { "components": {} }, "basemodelholder": { "components": {} }, "bind": { "components": { "Bind": { "description": "Bind directive provides dynamic attribute, property, and event listener binding functionality.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "pBind", "optional": false, "readonly": false, "type": "InputSignal<{ [key: string]: any }>", "default": "...", "description": "Dynamic attributes, properties, and event listeners to be applied to the host element." } ] } } } }, "blockui": { "components": { "BlockUI": { "description": "BlockUI can either block other components or the whole page.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "target", "optional": false, "readonly": false, "type": "any", "description": "Name of the local ng-template variable referring to another component." }, { "name": "autoZIndex", "optional": false, "readonly": false, "type": "boolean", "default": "true", "description": "Whether to automatically manage layering." }, { "name": "baseZIndex", "optional": false, "readonly": false, "type": "number", "default": "0", "description": "Base zIndex value to use in layering." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Class of the element.", "deprecated": "since v20.0.0, use " }, { "name": "blocked", "optional": false, "readonly": false, "type": "boolean", "description": "Current blocked state as a boolean." } ] }, "templates": { "description": "Defines the templates used by the component.", "values": [ { "name": "content", "description": "template of the content", "type": "TemplateRef", "parameters": [] } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-blockui", "description": "Class name of the root element" } ] } }, "types": { "components": {}, "templates": { "description": "Defines the templates used by the component.", "values": [ { "parent": "types", "name": "content", "parameters": [], "description": "Custom template of content." } ] }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "BlockUIPassThroughOptions", "description": "Custom pass-through(pt) options.", "props": [ { "name": "host", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the host's DOM element." }, { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." } ] } ] } } }, "breadcrumb": { "components": { "Breadcrumb": { "description": "Breadcrumb provides contextual information about page hierarchy.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "model", "optional": false, "readonly": false, "type": "MenuItem[]", "description": "An array of menuitems." }, { "name": "style", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the component." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Style class of the component." }, { "name": "home", "optional": false, "readonly": false, "type": "MenuItem", "description": "MenuItem configuration for the home icon." }, { "name": "homeAriaLabel", "optional": false, "readonly": false, "type": "string", "description": "Defines a string that labels the home icon for accessibility." } ] }, "emits": { "description": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "values": [ { "name": "onItemClick", "parameters": [ { "name": "event", "type": "BreadcrumbItemClickEvent" } ], "description": "Fired when an item is selected." } ] }, "templates": { "description": "Defines the templates used by the component.", "values": [ { "name": "item", "description": "Custom item template.", "type": "TemplateRef", "parameters": [] }, { "name": "separator", "description": "Custom separator template.", "type": "TemplateRef", "parameters": [] } ] } } }, "style": { "components": {}, "classes": { "values": [ { "class": "p-breadcrumb", "description": "Class name of the root element" }, { "class": "p-breadcrumb-list", "description": "Class name of the list element" }, { "class": "p-breadcrumb-home-item", "description": "Class name of the home item element" }, { "class": "p-breadcrumb-separator", "description": "Class name of the separator element" }, { "class": "p-breadcrumb-item", "description": "Class name of the item element" }, { "class": "p-breadcrumb-item-link", "description": "Class name of the item link element" }, { "class": "p-breadcrumb-item-icon", "description": "Class name of the item icon element" }, { "class": "p-breadcrumb-item-label", "description": "Class name of the item label element" } ] } }, "types": { "components": {}, "templates": { "description": "Defines the templates used by the component.", "values": [ { "parent": "types", "name": "item", "parameters": [ { "name": "context", "type": "BreadcrumbItemTemplateContext", "description": "item data." } ], "description": "Custom item template." }, { "parent": "types", "name": "separator", "parameters": [], "description": "Custom separator template." } ] }, "interfaces": { "description": "Defines the custom interfaces used by the module.", "values": [ { "name": "BreadcrumbPassThroughOptions", "description": "Custom pass-through(pt) options.", "props": [ { "name": "root", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the root's DOM element." }, { "name": "list", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the list's DOM element." }, { "name": "homeItem", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the home item's DOM element." }, { "name": "item", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the item's DOM element." }, { "name": "itemLink", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the item link's DOM element." }, { "name": "itemIcon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the item icon's DOM element." }, { "name": "itemLabel", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the item label's DOM element." }, { "name": "separator", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the separator's DOM element." }, { "name": "separatorIcon", "optional": true, "readonly": false, "type": "PassThroughOption", "description": "Used to pass attributes to the separator icon's DOM element." } ] }, { "name": "BreadcrumbItemTemplateContext", "description": "Custom item template context.", "props": [ { "name": "$implicit", "optional": false, "readonly": false, "type": "MenuItem", "description": "Menu item instance." } ] } ] } } }, "button": { "components": { "ButtonDirective": { "description": "Button directive is an extension to button component.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "ptButtonDirective", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the Button component.", "deprecated": "use pButtonPT instead." }, { "name": "pButtonPT", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the Button component." }, { "name": "pButtonUnstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "text", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a textual class to the button without a background initially." }, { "name": "plain", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a plain textual class to the button without a background initially." }, { "name": "raised", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a shadow to indicate elevation." }, { "name": "size", "optional": false, "readonly": false, "type": "\"small\" | \"large\"", "description": "Defines the size of the button." }, { "name": "outlined", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a border class without a background initially." }, { "name": "rounded", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a circular border radius to the button." }, { "name": "iconPos", "optional": false, "readonly": false, "type": "ButtonIconPosition", "default": "left", "description": "Position of the icon." }, { "name": "loadingIcon", "optional": false, "readonly": false, "type": "string", "description": "Icon to display in loading state." }, { "name": "fluid", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "undefined", "description": "Spans 100% width of the container when enabled." }, { "name": "label", "optional": false, "readonly": false, "type": "string", "description": "Text of the button.", "deprecated": "use pButtonLabel directive instead." }, { "name": "icon", "optional": false, "readonly": false, "type": "string", "description": "Name of the icon.", "deprecated": "use pButtonIcon directive instead" }, { "name": "loading", "optional": false, "readonly": false, "type": "boolean", "description": "Whether the button is in loading state." }, { "name": "buttonProps", "optional": false, "readonly": false, "type": "ButtonProps", "description": "Used to pass all properties of the ButtonProps to the Button component.", "deprecated": "assign props directly to the button element." }, { "name": "severity", "optional": false, "readonly": false, "type": "ButtonSeverity", "description": "Defines the style of the button." } ] } }, "Button": { "description": "Button is an extension to standard button element with icons and theming.", "props": { "description": "Defines the input properties of the component.", "values": [ { "name": "dt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Defines scoped design tokens of the component." }, { "name": "unstyled", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Indicates whether the component should be rendered without styles." }, { "name": "pt", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to pass attributes to DOM elements inside the component." }, { "name": "ptOptions", "optional": false, "readonly": false, "type": "InputSignal", "default": "undefined", "description": "Used to configure passthrough(pt) options of the component." }, { "name": "type", "optional": false, "readonly": false, "type": "string", "default": "button", "description": "Type of the button." }, { "name": "badge", "optional": false, "readonly": false, "type": "string", "description": "Value of the badge." }, { "name": "disabled", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When present, it specifies that the component should be disabled." }, { "name": "raised", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a shadow to indicate elevation." }, { "name": "rounded", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a circular border radius to the button." }, { "name": "text", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a textual class to the button without a background initially." }, { "name": "plain", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a plain textual class to the button without a background initially." }, { "name": "outlined", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a border class without a background initially." }, { "name": "link", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Add a link style to the button." }, { "name": "tabindex", "optional": false, "readonly": false, "type": "number", "description": "Add a tabindex to the button." }, { "name": "size", "optional": false, "readonly": false, "type": "\"small\" | \"large\"", "description": "Defines the size of the button." }, { "name": "variant", "optional": false, "readonly": false, "type": "\"text\" | \"outlined\"", "description": "Specifies the variant of the component." }, { "name": "style", "optional": false, "readonly": false, "type": "{ [klass: string]: any }", "description": "Inline style of the element." }, { "name": "styleClass", "optional": false, "readonly": false, "type": "string", "description": "Class of the element." }, { "name": "badgeClass", "optional": false, "readonly": false, "type": "string", "description": "Style class of the badge.", "deprecated": "use badgeSeverity instead." }, { "name": "badgeSeverity", "optional": false, "readonly": false, "type": "\"success\" | \"info\" | \"warn\" | \"danger\" | \"help\" | \"primary\" | \"secondary\" | \"contrast\"", "default": "secondary", "description": "Severity type of the badge." }, { "name": "ariaLabel", "optional": false, "readonly": false, "type": "string", "description": "Used to define a string that autocomplete attribute the current element." }, { "name": "autofocus", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "When present, it specifies that the component should automatically get focus on load." }, { "name": "iconPos", "optional": false, "readonly": false, "type": "ButtonIconPosition", "default": "left", "description": "Position of the icon." }, { "name": "icon", "optional": false, "readonly": false, "type": "string", "description": "Name of the icon." }, { "name": "label", "optional": false, "readonly": false, "type": "string", "description": "Text of the button." }, { "name": "loading", "optional": false, "readonly": false, "type": "boolean", "default": "false", "description": "Whether the button is in loading state." }, { "name": "loadingIcon", "optional": false, "readonly": false, "type": "string", "description": "Icon to display in loading state." }, { "name": "severity", "optional": false, "readonly": false, "type": "ButtonSeverity", "description": "Defines the style of the button." }, { "name": "buttonProps", "optional": false, "readonly": false, "type": "ButtonProps", "description": "Used to pass all properties of the ButtonProps to the Button component." }, { "name": "fluid", "optional": false, "readonly": false, "type": "InputSignalWithTransform", "default": "undefined", "description": "Spans 100% width of the container when enabled." } ] }, "emits": { "description": "Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.", "values": [ { "name": "onClick", "parameters": [ { "name": "event", "type": "MouseEvent" } ], "description": "Callback to execute when button is clicked.\nThis event is intended to be used with the component. Using a regular