quasar_get_component
Retrieve full documentation for any Quasar UI component, including API reference, props, events, slots, methods, and usage examples. Accepts component names with or without prefix.
Instructions
Get documentation for a specific Quasar UI component.
Returns the full markdown documentation including API reference, props, events, slots, methods, and usage examples.
Args:
component (string, required): Component name. Accepts various formats:
With prefix: 'q-btn', 'q-input', 'q-dialog'
Without prefix: 'btn', 'input', 'dialog'
Common aliases: 'button' -> 'btn', 'modal' -> 'dialog', 'dropdown' -> 'select'
response_format ('markdown' | 'json'): Output format (default: 'markdown')
Returns: For markdown: Full component documentation with API details For JSON: { "component": string, // Original input "normalized_name": string, // Resolved component name "path": string, // File path in docs "url": string, // Quasar.dev URL "content": string, // Documentation content "truncated": boolean // Whether content was truncated }
Examples:
Get button docs: component="btn" or component="q-btn" or component="button"
Get dialog docs: component="dialog" or component="modal"
Get input docs: component="input" or component="textfield"
Errors:
Returns "Component not found" with suggestions if component doesn't exist
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| component | Yes | Component name (e.g., 'btn', 'q-btn', 'input', 'q-input', 'dialog', 'button') | |
| response_format | No | Output format: 'markdown' for human-readable or 'json' for machine-readable | markdown |