{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/components/forms/qgds-checkbox-group/qgds-checkbox-group.ts", "declarations": [ { "kind": "class", "description": "Headless group wrapper for `` elements.\nAggregates composed `change` events from slotted checkboxes and fires\na single `qgds-change` event whose `detail.value` is a `string[]` of\nall currently checked values.\n\nUse `` for label, hint, and validation message rendering.", "name": "QGDSCheckboxGroup", "slots": [ { "description": "Accepts `` or any element that dispatches a composed `change` event and exposes `.type === \"checkbox\"`, `.value`, `.checked`.", "name": "" }, { "description": "Place any markup to be rendered within additional details.", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFieldGroupBase", "module": "src/components/forms/qgds-field-group-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Included in the `qgds-change` detail.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "renderInput", "inheritedFrom": { "name": "QGDSFieldGroupBase", "module": "src/components/forms/qgds-field-group-base.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size, propagated to all slotted checkboxes. Defaults to `\"lg\"`.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "`detail.value` is a `string[]` of checked values.", "name": "qgds-change" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size, propagated to all slotted checkboxes. Defaults to `\"lg\"`.", "fieldName": "size" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "superclass": { "name": "QGDSFieldGroupBase", "module": "/src/components/forms/qgds-field-group-base" }, "tagName": "qgds-checkbox-group", "customElement": true, "tagname": { "name": "qgds-checkbox-group", "description": "" } } ], "exports": [ { "kind": "js", "name": "FieldGroupChangeDetail", "declaration": { "name": "FieldGroupChangeDetail", "module": "src/components/forms/qgds-checkbox-group/qgds-checkbox-group.ts" } }, { "kind": "js", "name": "FieldGroupValue", "declaration": { "name": "FieldGroupValue", "module": "src/components/forms/qgds-checkbox-group/qgds-checkbox-group.ts" } }, { "kind": "custom-element-definition", "name": "qgds-checkbox-group", "declaration": { "name": "QGDSCheckboxGroup", "module": "src/components/forms/qgds-checkbox-group/qgds-checkbox-group.ts" } }, { "kind": "js", "name": "QGDSCheckboxGroup", "declaration": { "name": "QGDSCheckboxGroup", "module": "src/components/forms/qgds-checkbox-group/qgds-checkbox-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-checkbox/qgds-checkbox.ts", "declarations": [ { "kind": "class", "description": "A styled checkbox input that works standalone or inside ``.\nRe-dispatches a composed `change` event from the host so `qgds-field-group`\ncan intercept it across the shadow DOM boundary.", "name": "QGDSCheckbox", "members": [ { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox is checked.", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "Visible label text.", "attribute": "label" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "\"\"", "description": "Input name, required when used outside a field group.", "attribute": "name" }, { "kind": "field", "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size of the checkbox. Defaults to `\"lg\"`.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "string" }, "readonly": true, "default": "\"checkbox\"", "description": "Exposed so qgds-field-group can identify this as a checkbox via duck-typing" }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error' | undefined" }, "attribute": "validation-state", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "The value submitted when the checkbox is checked.", "attribute": "value" } ], "events": [ { "type": { "text": "Event" }, "description": "Native composed change event re-dispatched from the host.", "name": "change" } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox is checked.", "fieldName": "checked" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox is disabled.", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "Visible label text.", "fieldName": "label" }, { "name": "name", "type": { "text": "string" }, "default": "\"\"", "description": "Input name, required when used outside a field group.", "fieldName": "name" }, { "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size of the checkbox. Defaults to `\"lg\"`.", "fieldName": "size" }, { "name": "validation-state", "type": { "text": "'success' | 'error' | undefined" }, "fieldName": "validationState" }, { "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "The value submitted when the checkbox is checked.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=11056-321348&p=f", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/checkbox", "description": "" }, "tagName": "qgds-checkbox", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-checkbox", "declaration": { "name": "QGDSCheckbox", "module": "src/components/forms/qgds-checkbox/qgds-checkbox.ts" } }, { "kind": "js", "name": "QGDSCheckbox", "declaration": { "name": "QGDSCheckbox", "module": "src/components/forms/qgds-checkbox/qgds-checkbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-field-group-base.ts", "declarations": [ { "kind": "class", "description": "Headless base class for checkbox and radio group components.\nHandles event wiring, input resolution, and `qgds-change` dispatch.\nSubclasses implement `_initialValue()` and `_applyChange()` for their\nspecific value-aggregation logic.\n\nNot registered as a custom element — use `` or\n`` instead.", "name": "QGDSFieldGroupBase", "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "renderInput" }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "superclass": { "name": "QGDSFormField", "module": "/src/components/forms/qgds-form-field" }, "slots": [ { "description": "Place any markup to be rendered within additional details.", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ] } ], "exports": [ { "kind": "js", "name": "QGDSFieldGroupBase", "declaration": { "name": "QGDSFieldGroupBase", "module": "src/components/forms/qgds-field-group-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-form-field.ts", "declarations": [ { "kind": "class", "description": "Abstract base class for all QGDS form field components.\nProvides common properties, validation handling, rendering logic, and\nform association (via ElementInternals) for all form field inputs.", "name": "QGDSFormField", "slots": [ { "description": "Place any markup to be rendered within additional details.", "name": "details" } ], "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled" }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true" }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ] }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint" }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id" }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if" }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label" }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "attribute": "name" }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate" }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly" }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required" }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus" }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled" }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint" }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id" }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf" }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label" }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name" }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate" }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly" }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage" }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState" }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "QGDSFormField", "declaration": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-radio-group/qgds-radio-group.ts", "declarations": [ { "kind": "class", "description": "Headless group wrapper for `` elements.\nAggregates composed `change` events from slotted radios, enforces mutual\nexclusivity across shadow roots, and fires a `qgds-change` event whose\n`detail.value` is the currently selected `string`.\n\nUse `` for label, hint, and validation message rendering.", "name": "QGDSRadioGroup", "slots": [ { "description": "Accepts `` or any element that dispatches a composed `change` event and exposes `.type === \"radio\"`, `.value`, `.checked`.", "name": "" }, { "description": "Place any markup to be rendered within additional details.", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFieldGroupBase", "module": "src/components/forms/qgds-field-group-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Included in the `qgds-change` detail.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "renderInput", "inheritedFrom": { "name": "QGDSFieldGroupBase", "module": "src/components/forms/qgds-field-group-base.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size, propagated to all slotted radios. Defaults to `\"lg\"`.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "`detail.value` is the selected radio's value string.", "name": "qgds-change" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size, propagated to all slotted radios. Defaults to `\"lg\"`.", "fieldName": "size" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "superclass": { "name": "QGDSFieldGroupBase", "module": "/src/components/forms/qgds-field-group-base" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=11056-321347", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/radio", "description": "" }, "tagName": "qgds-radio-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "FieldGroupChangeDetail", "declaration": { "name": "FieldGroupChangeDetail", "module": "src/components/forms/qgds-radio-group/qgds-radio-group.ts" } }, { "kind": "js", "name": "FieldGroupValue", "declaration": { "name": "FieldGroupValue", "module": "src/components/forms/qgds-radio-group/qgds-radio-group.ts" } }, { "kind": "custom-element-definition", "name": "qgds-radio-group", "declaration": { "name": "QGDSRadioGroup", "module": "src/components/forms/qgds-radio-group/qgds-radio-group.ts" } }, { "kind": "js", "name": "QGDSRadioGroup", "declaration": { "name": "QGDSRadioGroup", "module": "src/components/forms/qgds-radio-group/qgds-radio-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-radio/qgds-radio.ts", "declarations": [ { "kind": "class", "description": "A styled radio input that works standalone or inside ``.\nRe-dispatches a composed `change` event from the host so `qgds-field-group`\ncan intercept it across the shadow DOM boundary.\n\nBecause each `` has its own shadow root, native browser radio\ngrouping by `name` does not work across instances. Mutual exclusivity is\nmanaged by `` when this element is used inside one.", "name": "QGDSRadio", "members": [ { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether this radio is selected.", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this radio is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "Visible label text.", "attribute": "label" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "\"\"", "description": "Input name, required for form association.", "attribute": "name" }, { "kind": "field", "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size of the radio. Defaults to `\"lg\"`.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "string" }, "readonly": true, "default": "\"radio\"", "description": "Exposed so qgds-field-group can identify this as a radio via duck-typing" }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "Visual validation state.", "attribute": "validation-state", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "The value submitted when the radio is selected.", "attribute": "value" } ], "events": [ { "type": { "text": "Event" }, "description": "Native composed change event re-dispatched from the host.", "name": "change" } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether this radio is selected.", "fieldName": "checked" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this radio is disabled.", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "Visible label text.", "fieldName": "label" }, { "name": "name", "type": { "text": "string" }, "default": "\"\"", "description": "Input name, required for form association.", "fieldName": "name" }, { "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"lg\"", "description": "Visual size of the radio. Defaults to `\"lg\"`.", "fieldName": "size" }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "Visual validation state.", "fieldName": "validationState" }, { "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "The value submitted when the radio is selected.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=11056-321347", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/radio", "description": "" }, "tagName": "qgds-radio", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-radio", "declaration": { "name": "QGDSRadio", "module": "src/components/forms/qgds-radio/qgds-radio.ts" } }, { "kind": "js", "name": "QGDSRadio", "declaration": { "name": "QGDSRadio", "module": "src/components/forms/qgds-radio/qgds-radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-select/qgds-select-optgroup.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSSelectOptgroup", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "getOptions", "return": { "type": { "text": "QGDSSelectOption[]" } }, "description": "Get all qgds-select-option children" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"\"", "attribute": "label" }, { "kind": "method", "name": "toNativeOptgroup", "return": { "type": { "text": "HTMLOptGroupElement" } }, "description": "Convert this custom element to a native HTMLOptGroupElement" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string" }, "default": "\"\"", "fieldName": "label" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-select-optgroup", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-select-optgroup", "declaration": { "name": "QGDSSelectOptgroup", "module": "src/components/forms/qgds-select/qgds-select-optgroup.ts" } }, { "kind": "js", "name": "QGDSSelectOptgroup", "declaration": { "name": "QGDSSelectOptgroup", "module": "src/components/forms/qgds-select/qgds-select-optgroup.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-select/qgds-select-option.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSSelectOption", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "getTextContent", "return": { "type": { "text": "string" } }, "description": "Get the text content of the option" }, { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "default": "\"\"", "attribute": "label" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "attribute": "selected", "reflects": true }, { "kind": "method", "name": "toNativeOption", "return": { "type": { "text": "HTMLOptionElement" } }, "description": "Convert this custom element to a native HTMLOptionElement" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "attribute": "value" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string | undefined" }, "default": "\"\"", "fieldName": "label" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" }, { "name": "value", "type": { "text": "string" }, "default": "\"\"", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-select-option", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-select-option", "declaration": { "name": "QGDSSelectOption", "module": "src/components/forms/qgds-select/qgds-select-option.ts" } }, { "kind": "js", "name": "QGDSSelectOption", "declaration": { "name": "QGDSSelectOption", "module": "src/components/forms/qgds-select/qgds-select-option.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-select/qgds-select.ts", "declarations": [ { "kind": "class", "description": "A native select dropdown component for form inputs.\nOnly accepts QGDSSelectOption and QGDSSelectOptgroup elements as children.", "name": "QGDSSelect", "slots": [ { "description": "Accepts {@link QGDSSelectOption} and {@link QGDSSelectOptgroup} elements as options.", "name": "" }, { "description": "Place any markup to be rendered within additional details.", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "members": [ { "type": { "text": "Boolean" }, "description": "Whether the select should automatically receive focus.", "name": "autofocus", "kind": "field" }, { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "description": "Focus the select element\nPublic method for programmatic focus management" }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "description": "Form lifecycle callbacks", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "getSelectedValues", "return": { "type": { "text": "string[]" } }, "description": "Get all selected values as an array\nConvenience method for multiple select" }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "multiple", "type": { "text": "Boolean" }, "default": "false", "description": "Whether multiple selections are allowed.", "attribute": "multiple", "reflects": true }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "String" }, "default": "\"Please select\"", "description": "Placeholder text shown as the first (unselectable) option.", "attribute": "placeholder" }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "setSelectedValues", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "values", "type": { "text": "string[]" } } ], "description": "Set selected values from an array\nConvenience method for multiple select" }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "size", "type": { "text": "Number" }, "description": "Number of visible options when multiple is enabled.", "attribute": "size" }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "valueAsArray", "type": { "text": "string[]" }, "description": "Set value from an array\nUseful for multiple select handling" }, { "kind": "field", "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "attribute": "variant" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "multiple", "type": { "text": "Boolean" }, "default": "false", "description": "Whether multiple selections are allowed.", "fieldName": "multiple" }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "placeholder", "type": { "text": "String" }, "default": "\"Please select\"", "description": "Placeholder text shown as the first (unselectable) option.", "fieldName": "placeholder" }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "size", "type": { "text": "Number" }, "description": "Number of visible options when multiple is enabled.", "fieldName": "size" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "fieldName": "variant" } ], "superclass": { "name": "QGDSFormField", "module": "/src/components/forms/qgds-form-field" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=11056-321345", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/select", "description": "" }, "tagName": "qgds-select", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-select", "declaration": { "name": "QGDSSelect", "module": "src/components/forms/qgds-select/qgds-select.ts" } }, { "kind": "js", "name": "QGDSSelect", "declaration": { "name": "QGDSSelect", "module": "src/components/forms/qgds-select/qgds-select.ts" } }, { "kind": "js", "name": "QGDSSelectOptgroup", "declaration": { "name": "QGDSSelectOptgroup", "module": "./qgds-select-optgroup.js" } }, { "kind": "js", "name": "QGDSSelectOption", "declaration": { "name": "QGDSSelectOption", "module": "./qgds-select-option.js" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-text-input/qgds-text-input.ts", "declarations": [ { "kind": "class", "description": "\nText inputs are input fields typically used in forms that allow the user to enter text data in a structured format.\nText inputs should be accompanied by labels.", "name": "QGDSTextInput", "slots": [ { "description": "place any markup to be rendered within the \"Summary\" dropdown", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "maxLength", "type": { "text": "Number" }, "attribute": "maxlength" }, { "kind": "field", "name": "minLength", "type": { "text": "Number" }, "attribute": "minlength" }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "pattern", "type": { "text": "Regex" }, "attribute": "pattern" }, { "kind": "field", "name": "placeholder", "type": { "text": "String" }, "description": "Text to display when the value is empty.", "attribute": "placeholder" }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "spellcheck", "type": { "text": "Boolean" }, "default": "false", "attribute": "spellcheck" }, { "kind": "field", "name": "type", "type": { "text": "'number' | 'email' | 'text' | 'password' | 'tel' | 'url'" }, "description": "Provides built in validation for specific types. Either \"text\"(default), \"email\", \"password\", \"number\", \"tel\", \"url\".", "default": "\"text\"", "attribute": "type" }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "attribute": "variant" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "maxlength", "type": { "text": "Number" }, "fieldName": "maxLength" }, { "name": "minlength", "type": { "text": "Number" }, "fieldName": "minLength" }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "pattern", "type": { "text": "Regex" }, "fieldName": "pattern" }, { "name": "placeholder", "type": { "text": "String" }, "description": "Text to display when the value is empty.", "fieldName": "placeholder" }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "spellcheck", "type": { "text": "Boolean" }, "default": "false", "fieldName": "spellcheck" }, { "name": "type", "type": { "text": "'number' | 'email' | 'text' | 'password' | 'tel' | 'url'" }, "description": "Provides built in validation for specific types. Either \"text\"(default), \"email\", \"password\", \"number\", \"tel\", \"url\".", "default": "\"text\"", "fieldName": "type" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "fieldName": "variant" } ], "superclass": { "name": "QGDSFormField", "module": "/src/components/forms/qgds-form-field" }, "tagName": "qgds-text-input", "customElement": true, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-97997&m=dev", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/text-input", "description": "" }, "tagname": { "name": "qgds-text-input", "description": "" } }, { "kind": "variable", "name": "tagName", "type": { "text": "string" }, "default": "\"qgds-text-input\"" } ], "exports": [ { "kind": "custom-element-definition", "name": "", "declaration": { "name": "QGDSTextInput", "module": "src/components/forms/qgds-text-input/qgds-text-input.ts" } }, { "kind": "js", "name": "QGDSTextInput", "declaration": { "name": "QGDSTextInput", "module": "src/components/forms/qgds-text-input/qgds-text-input.ts" } }, { "kind": "js", "name": "tagName", "declaration": { "name": "tagName", "module": "src/components/forms/qgds-text-input/qgds-text-input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/forms/qgds-textarea/qgds-textarea.ts", "declarations": [ { "kind": "class", "description": "Textareas are input fields typically used in forms that allow the user to enter multi-line text data.", "name": "QGDSTextarea", "slots": [ { "description": "Place any markup to be rendered within additional details.", "name": "details", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } } ], "members": [ { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "attribute": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } } ], "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "attribute": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "attribute": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "indicateIf", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "attribute": "indicate-if", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "attribute": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "maxLength", "type": { "text": "Number" }, "description": "Maximum number of characters allowed.", "attribute": "maxlength" }, { "kind": "field", "name": "minLength", "type": { "text": "Number" }, "description": "Minimum number of characters required.", "attribute": "minlength" }, { "kind": "field", "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "attribute": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "nativeValidate", "type": { "text": "boolean | undefined" }, "default": "false", "attribute": "native-validate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "String" }, "description": "Text to display when the value is empty.", "attribute": "placeholder" }, { "kind": "field", "name": "readOnly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "attribute": "readonly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "attribute": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }", "description": "Set delegatesFocus: true for programatic focus, autofocus", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "spellcheck", "type": { "text": "Boolean" }, "default": "false", "description": "Enable browser spell checking.", "attribute": "spellcheck" }, { "kind": "field", "name": "validationMessage", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "attribute": "validation-message", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "validationState", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "attribute": "validation-state", "reflects": true, "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "attribute": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "attribute": "variant" } ], "attributes": [ { "name": "disabled", "type": { "text": "Boolean" }, "default": "false", "description": "Disables the field when true.", "fieldName": "disabled", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "hint", "type": { "text": "String" }, "description": "Hint text to guide the user.", "fieldName": "hint", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "id", "type": { "text": "String" }, "description": "Required unique identifier for the form field.", "fieldName": "id", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "indicate-if", "type": { "text": "'required' | 'optional' | 'none'" }, "default": "\"required\"", "description": "Display indicator for \"required\", \"optional\", or \"none\".", "fieldName": "indicateIf", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "label", "type": { "text": "String" }, "description": "The form field's label text.", "fieldName": "label", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "maxlength", "type": { "text": "Number" }, "description": "Maximum number of characters allowed.", "fieldName": "maxLength" }, { "name": "minlength", "type": { "text": "Number" }, "description": "Minimum number of characters required.", "fieldName": "minLength" }, { "name": "name", "type": { "text": "String" }, "description": "Required name attribute for form submission.", "fieldName": "name", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "native-validate", "type": { "text": "boolean | undefined" }, "default": "false", "fieldName": "nativeValidate", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "placeholder", "type": { "text": "String" }, "description": "Text to display when the value is empty.", "fieldName": "placeholder" }, { "name": "readonly", "type": { "text": "Boolean" }, "default": "false", "description": "Makes the field read-only when true.", "fieldName": "readOnly", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "required", "type": { "text": "Boolean" }, "default": "false", "description": "Indicates whether the field is required.", "fieldName": "required", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "spellcheck", "type": { "text": "Boolean" }, "default": "false", "description": "Enable browser spell checking.", "fieldName": "spellcheck" }, { "name": "validation-message", "type": { "text": "String" }, "description": "Validation feedback message displayed with the state.", "fieldName": "validationMessage", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "validation-state", "type": { "text": "'success' | 'error'" }, "description": "The validation state, either \"success\" or \"error\".", "fieldName": "validationState", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "value", "type": { "text": "String" }, "default": "\"\"", "description": "The current value of the field.", "fieldName": "value", "inheritedFrom": { "name": "QGDSFormField", "module": "src/components/forms/qgds-form-field.ts" } }, { "name": "variant", "type": { "text": "'filled' | 'outlined'" }, "description": "The visual style of the input, either \"filled\" or \"outlined\".", "fieldName": "variant" } ], "superclass": { "name": "QGDSFormField", "module": "/src/components/forms/qgds-form-field" }, "tagName": "qgds-textarea", "customElement": true, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-97997&m=dev", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/text-input", "description": "" }, "tagname": { "name": "qgds-textarea", "description": "" } }, { "kind": "variable", "name": "tagName", "type": { "text": "string" }, "default": "\"qgds-textarea\"" } ], "exports": [ { "kind": "custom-element-definition", "name": "", "declaration": { "name": "QGDSTextarea", "module": "src/components/forms/qgds-textarea/qgds-textarea.ts" } }, { "kind": "js", "name": "QGDSTextarea", "declaration": { "name": "QGDSTextarea", "module": "src/components/forms/qgds-textarea/qgds-textarea.ts" } }, { "kind": "js", "name": "tagName", "declaration": { "name": "tagName", "module": "src/components/forms/qgds-textarea/qgds-textarea.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-accordion-group/qgds-accordion-group.ts", "declarations": [ { "kind": "class", "description": "QGDS Accordion Group Component", "name": "QGDSAccordionGroup", "slots": [ { "description": "Any number of `qgds-accordion`s. All other elements will not be rendered.", "name": "default" } ], "members": [ { "kind": "field", "name": "showControls", "type": { "text": "true | false | \"auto\"" }, "default": "\"auto\"", "description": "Show \"Open all\" / \"Close all\" controls. If set to \"auto\", controls will displayed if 3 or more accordions as children items.", "attribute": "show-controls" } ], "attributes": [ { "name": "show-controls", "type": { "text": "true | false | \"auto\"" }, "default": "\"auto\"", "description": "Show \"Open all\" / \"Close all\" controls. If set to \"auto\", controls will displayed if 3 or more accordions as children items.", "fieldName": "showControls" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-accordion-group", "customElement": true, "website": { "name": "https://www.designsystem.qld.gov.au/components/accordion", "description": "" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-98109", "description": "" }, "tagname": { "name": "qgds-accordion-group", "description": "" } }, { "kind": "variable", "name": "tagName", "type": { "text": "string" }, "default": "\"qgds-accordion-group\"" } ], "exports": [ { "kind": "custom-element-definition", "name": "", "declaration": { "name": "QGDSAccordionGroup", "module": "src/components/qgds-accordion-group/qgds-accordion-group.ts" } }, { "kind": "js", "name": "QGDSAccordionGroup", "declaration": { "name": "QGDSAccordionGroup", "module": "src/components/qgds-accordion-group/qgds-accordion-group.ts" } }, { "kind": "js", "name": "tagName", "declaration": { "name": "tagName", "module": "src/components/qgds-accordion-group/qgds-accordion-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-accordion/qgds-accordion.ts", "declarations": [ { "kind": "class", "description": "QGDS Accordion Component", "name": "QGDSAccordion", "slots": [ { "description": "The content to be revealed when the accordion is expanded. Can include any HTML elements.", "name": "default" } ], "members": [ { "kind": "field", "name": "isOpen", "type": { "text": "boolean" }, "default": "false", "description": "Reflects the open state of the accordion. Can be used to programmatically control the accordion.", "attribute": "is-open", "reflects": true }, { "kind": "field", "name": "title", "type": { "text": "string" }, "default": "\"\"", "description": "The title displayed in the accordion summary.", "attribute": "title" } ], "events": [ { "description": "Emitted when the accordion is toggled open or closed.", "name": "qgds-toggle" } ], "attributes": [ { "name": "is-open", "type": { "text": "boolean" }, "default": "false", "description": "Reflects the open state of the accordion. Can be used to programmatically control the accordion.", "fieldName": "isOpen" }, { "name": "title", "type": { "text": "string" }, "default": "\"\"", "description": "The title displayed in the accordion summary.", "fieldName": "title" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-accordion", "customElement": true, "website": { "name": "https://www.designsystem.qld.gov.au/components/accordion", "description": "" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-98109", "description": "" }, "tagname": { "name": "qgds-accordion", "description": "" } }, { "kind": "variable", "name": "tagName", "type": { "text": "string" }, "default": "\"qgds-accordion\"" } ], "exports": [ { "kind": "custom-element-definition", "name": "", "declaration": { "name": "QGDSAccordion", "module": "src/components/qgds-accordion/qgds-accordion.ts" } }, { "kind": "js", "name": "QGDSAccordion", "declaration": { "name": "QGDSAccordion", "module": "src/components/qgds-accordion/qgds-accordion.ts" } }, { "kind": "js", "name": "tagName", "declaration": { "name": "tagName", "module": "src/components/qgds-accordion/qgds-accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-blockquote/qgds-blockquote.ts", "declarations": [ { "kind": "class", "description": "Used to highlight important information within content areas. It features a prominent border and background to draw attention to its contents.", "name": "QGDSBlockquote", "cssProperties": [ { "type": { "text": "color" }, "description": "Override the background color of the blockquote.", "name": "--bg" }, { "type": { "text": "color" }, "description": "Override the border color of the blockquote.", "name": "--border" }, { "type": { "text": "color" }, "description": "Override the text color within the blockquote.", "name": "--fg" }, { "type": { "text": "color" }, "description": "Override the citation text color within the blockquote.", "name": "--cite-fg" } ], "slots": [ { "description": "Default content slot accepts general typographic HTML content, including paragraphs, lists, and links.", "name": "" } ], "members": [ { "kind": "field", "name": "citeLabel", "type": { "text": "string" }, "default": "\"\"", "description": "The text for the citation", "attribute": "cite-label" }, { "kind": "field", "name": "citeUrl", "type": { "text": "string" }, "default": "\"\"", "description": "The URL of the source of the quote", "attribute": "cite-url" } ], "attributes": [ { "name": "cite-label", "type": { "text": "string" }, "default": "\"\"", "description": "The text for the citation", "fieldName": "citeLabel" }, { "name": "cite-url", "type": { "text": "string" }, "default": "\"\"", "description": "The URL of the source of the quote", "fieldName": "citeUrl" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=133254-206549&t=FIwjIg0V3JbsLmNw-0", "description": "" }, "tagName": "qgds-blockquote", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-blockquote", "declaration": { "name": "QGDSBlockquote", "module": "src/components/qgds-blockquote/qgds-blockquote.ts" } }, { "kind": "js", "name": "QGDSBlockquote", "declaration": { "name": "QGDSBlockquote", "module": "src/components/qgds-blockquote/qgds-blockquote.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-breadcrumbs/qgds-breadcrumbs-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSBreadcrumbsItem", "members": [ { "kind": "field", "name": "isDropdownItem", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "isExpanded", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "isLast", "type": { "text": "boolean" }, "default": "false", "attribute": "is-last", "reflects": true }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "\"\"", "attribute": "rel" }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true, }" }, { "kind": "field", "name": "target", "type": { "text": "string" }, "default": "\"\"", "attribute": "target" }, { "kind": "field", "name": "url", "type": { "text": "string" }, "default": "\"\"", "attribute": "url" } ], "attributes": [ { "name": "is-last", "type": { "text": "boolean" }, "default": "false", "fieldName": "isLast" }, { "name": "rel", "type": { "text": "string" }, "default": "\"\"", "fieldName": "rel" }, { "name": "target", "type": { "text": "string" }, "default": "\"\"", "fieldName": "target" }, { "name": "url", "type": { "text": "string" }, "default": "\"\"", "fieldName": "url" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-breadcrumbs-item", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-breadcrumbs-item", "declaration": { "name": "QGDSBreadcrumbsItem", "module": "src/components/qgds-breadcrumbs/qgds-breadcrumbs-item.ts" } }, { "kind": "js", "name": "QGDSBreadcrumbsItem", "declaration": { "name": "QGDSBreadcrumbsItem", "module": "src/components/qgds-breadcrumbs/qgds-breadcrumbs-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-breadcrumbs/qgds-breadcrumbs.ts", "declarations": [ { "kind": "class", "description": "Breadcrumbs show users where they are in the website hierarchy and how to navigate back or up to previous levels or content. They supports desktop, and mobile/tablet resolutions.", "name": "QGDSBreadcrumbs", "slots": [ { "description": "The breadcrumbs items, which should be implemented using {@link qgds-breadcrumbs-item}", "name": "" } ], "members": [], "attributes": [ { "description": "Accessible label for the breadcrumbs navigation, defaults to \"breadcrumbs\"", "name": "aria-label" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-98076&p=f&m=dev", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/breadcrumbs", "description": "" }, "tagName": "qgds-breadcrumbs", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-breadcrumbs", "declaration": { "name": "QGDSBreadcrumbs", "module": "src/components/qgds-breadcrumbs/qgds-breadcrumbs.ts" } }, { "kind": "js", "name": "QGDSBreadcrumbs", "declaration": { "name": "QGDSBreadcrumbs", "module": "src/components/qgds-breadcrumbs/qgds-breadcrumbs.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-button/qgds-button.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSButton", "members": [ { "kind": "field", "name": "ariaLabel", "type": { "text": "string | null" }, "default": "null", "attribute": "aria-label" }, { "kind": "field", "name": "buttonState", "readonly": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "eventTitle", "type": { "text": "string" }, "default": "\"qgds-button-click\"", "attribute": "event-title" }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "attribute": "href", "reflects": true }, { "kind": "field", "name": "iconSize", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'" }, "default": "\"md\"", "attribute": "icon-size" }, { "kind": "field", "name": "isLoading", "type": { "text": "boolean" }, "default": "false", "attribute": "is-loading", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"Button\"", "attribute": "label" }, { "kind": "field", "name": "loadingLabel", "type": { "text": "string" }, "default": "\"Loading...\"", "attribute": "loading-label" }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "attribute": "target" }, { "kind": "field", "name": "trailingIcon", "type": { "text": "boolean" }, "default": "false", "attribute": "trailing-icon", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "HTMLButtonElement[\"type\"]" }, "default": "\"button\"", "attribute": "type" }, { "kind": "field", "name": "uniqueID", "type": { "text": "string | undefined" }, "attribute": "id", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "\"primary\"", "attribute": "variant" } ], "attributes": [ { "name": "aria-label", "type": { "text": "string | null" }, "default": "null", "fieldName": "ariaLabel" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "event-title", "type": { "text": "string" }, "default": "\"qgds-button-click\"", "fieldName": "eventTitle" }, { "name": "href", "type": { "text": "string | undefined" }, "fieldName": "href" }, { "name": "icon-size", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'" }, "default": "\"md\"", "fieldName": "iconSize" }, { "name": "id", "type": { "text": "string | undefined" }, "fieldName": "uniqueID" }, { "name": "is-loading", "type": { "text": "boolean" }, "default": "false", "fieldName": "isLoading" }, { "name": "label", "type": { "text": "string" }, "default": "\"Button\"", "fieldName": "label" }, { "name": "loading-label", "type": { "text": "string" }, "default": "\"Loading...\"", "fieldName": "loadingLabel" }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "fieldName": "target" }, { "name": "trailing-icon", "type": { "text": "boolean" }, "default": "false", "fieldName": "trailingIcon" }, { "name": "type", "type": { "text": "HTMLButtonElement[\"type\"]" }, "default": "\"button\"", "fieldName": "type" }, { "name": "variant", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "\"primary\"", "fieldName": "variant" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-button", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-button", "declaration": { "name": "QGDSButton", "module": "src/components/qgds-button/qgds-button.ts" } }, { "kind": "js", "name": "QGDSButton", "declaration": { "name": "QGDSButton", "module": "src/components/qgds-button/qgds-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-call-to-action/qgds-call-to-action.ts", "declarations": [ { "kind": "class", "description": "A styled call-to-action link used to promote a primary navigation action.\nTypically placed at the bottom of a link column to direct users to a full listing.", "name": "QGDSCallToAction", "cssProperties": [ { "type": { "text": "length" }, "description": "Override the icon size (default 2rem).", "name": "--qgds-link-icon-size" }, { "type": { "text": "length|string" }, "description": "Override the font size (1rem by default, 1.25rem when is-view-all).", "name": "--qgds-link-font-size" }, { "type": { "text": "number|string" }, "description": "Override the font weight.", "name": "--qgds-link-font-weight" }, { "type": { "text": "length" }, "description": "Override the link block-end padding.", "name": "--qgds-link-padding" }, { "type": { "text": "length|string" }, "description": "Override the inline-start margin.", "name": "--qgds-link-margin-inline-start" } ], "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "\"#\"", "description": "The destination URL. Defaults to \"#\".", "attribute": "href" }, { "type": { "text": "boolean" }, "description": "When true, uses the \"view-all\" icon at size \"lg\". Otherwise uses \"arrow-right\" at size \"md\".", "name": "is-view-all", "kind": "field" }, { "kind": "field", "name": "isViewAll", "type": { "text": "boolean" }, "default": "false", "attribute": "is-view-all", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"View all\"", "description": "The visible link text. Defaults to \"View all\".", "attribute": "label" } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "\"#\"", "description": "The destination URL. Defaults to \"#\".", "fieldName": "href" }, { "name": "is-view-all", "type": { "text": "boolean" }, "default": "false", "fieldName": "isViewAll" }, { "name": "label", "type": { "text": "string" }, "default": "\"View all\"", "description": "The visible link text. Defaults to \"View all\".", "fieldName": "label" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit", "description": "" }, "tagName": "qgds-call-to-action", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-call-to-action", "declaration": { "name": "QGDSCallToAction", "module": "src/components/qgds-call-to-action/qgds-call-to-action.ts" } }, { "kind": "js", "name": "QGDSCallToAction", "declaration": { "name": "QGDSCallToAction", "module": "src/components/qgds-call-to-action/qgds-call-to-action.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-callout/qgds-callout.ts", "declarations": [ { "kind": "class", "description": "Used to highlight important information within content areas. It features a prominent border and background to draw attention to its contents.", "name": "QGDSCallout", "cssProperties": [ { "type": { "text": "color" }, "description": "Override the background color of the callout.", "name": "--callout-background" }, { "type": { "text": "color" }, "description": "Override the border color of the callout.", "name": "--callout-border" }, { "type": { "text": "color" }, "description": "Override the text color within the callout.", "name": "--callout-text" } ], "slots": [ { "description": "Default content slot accepts general typographic HTML content, including paragraphs, lists, and links.", "name": "" } ], "members": [ { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "\"Callout heading\"", "description": "Callout heading text", "attribute": "heading" }, { "kind": "field", "name": "headingLevel", "type": { "text": "'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h3\"", "description": "Semantic heading level (h2-h6)", "attribute": "heading-level", "reflects": true }, { "kind": "field", "name": "headingSize", "type": { "text": "'xs' | 'sm' | 'md'" }, "description": "Heading size provides additional control over the visual size of the heading, independent of the semantic level.", "attribute": "heading-size", "reflects": true } ], "attributes": [ { "description": "Callout heading text", "name": "heading", "type": { "text": "string" }, "default": "\"Callout heading\"", "fieldName": "heading" }, { "name": "heading-level", "type": { "text": "'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h3\"", "description": "Semantic heading level (h2-h6)", "fieldName": "headingLevel" }, { "name": "heading-size", "type": { "text": "'xs' | 'sm' | 'md'" }, "description": "Heading size provides additional control over the visual size of the heading, independent of the semantic level.", "fieldName": "headingSize" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=120360-73541&m=dev", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/callout", "description": "" }, "tagName": "qgds-callout", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-callout", "declaration": { "name": "QGDSCallout", "module": "src/components/qgds-callout/qgds-callout.ts" } }, { "kind": "js", "name": "QGDSCallout", "declaration": { "name": "QGDSCallout", "module": "src/components/qgds-callout/qgds-callout.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-card/qgds-card.ts", "declarations": [ { "kind": "class", "description": "The card component is used to provide a brief summary of content or a task, often with a link to more detail.", "name": "QGDSCard", "cssProperties": [ { "description": "Override the card background colour.", "name": "--bg" }, { "description": "Override the card foreground colour.", "name": "--fg" }, { "description": "Override the card border colour.", "name": "--border" }, { "description": "Override the card border radius.", "name": "--border-radius" } ], "slots": [ { "description": "The card's main body text.", "name": "(default)" }, { "description": "CTA links in the card footer (used with action=\"multiple\").", "name": "footer-links" }, { "description": "Tag chips in the card footer (used with action=\"multiple\").", "name": "footer-tags" }, { "description": "Plain text or heading in the card footer.", "name": "footer-text" } ], "members": [ { "kind": "field", "name": "action", "type": { "text": "'none' | 'single' | 'multiple'" }, "default": "\"none\"", "description": "Card's primary behaviour: \"none\" (non-clickable), \"single\" (whole card is a link), \"multiple\" (independent footer links).", "attribute": "action", "reflects": true }, { "kind": "field", "name": "ariaLabel", "type": { "text": "string" }, "default": "null", "description": "Accessible name override when the heading is insufficient.", "attribute": "aria-label" }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "\"\"", "description": "The card's heading text.", "attribute": "heading" }, { "kind": "field", "name": "headingLevel", "type": { "text": "'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h3\"", "description": "Semantic heading level (h2-h6).", "attribute": "heading-level" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "URL for single-action cards, and primary link for multiple-action cards.", "attribute": "href" }, { "kind": "field", "name": "iconName", "type": { "text": "'close' | 'search' | 'status-cancel' | 'status-danger' | 'status-error' | 'status-information' | 'status-maintenance' | 'status-success' | 'status-warning' | 'accessibility' | 'alert-cancel-filled' | 'alert-cancel' | 'alert-danger' | 'alert-error' | 'alert-information' | 'alert-maintenance' | 'alert-success' | 'alert-warning' | 'announcement' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'article' | 'attach' | 'audio' | 'calendar' | 'car' | 'chart' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clock' | 'code' | 'copy' | 'cost-money' | 'delete' | 'design' | 'direction-up-down' | 'directions' | 'document-error' | 'document-pdf' | 'document-spreadsheet' | 'document-word' | 'document' | 'download' | 'edit' | 'email' | 'enlarge' | 'external-link' | 'facebook' | 'favourite' | 'filter' | 'global-nav' | 'help' | 'hide' | 'home' | 'identity-face' | 'identity' | 'image' | 'instagram' | 'language' | 'like' | 'linkedin' | 'links' | 'location' | 'lock-open' | 'lock' | 'login' | 'logout' | 'manage-accounts' | 'menu' | 'microphone' | 'minus' | 'more-horizontal' | 'more-vertical' | 'notifications-circle' | 'notifications' | 'op-ed' | 'parking' | 'pause-circle' | 'pdf' | 'pending' | 'phone' | 'play-circle' | 'plus' | 'podcasts' | 'print' | 'profile' | 'refresh' | 'save' | 'settings' | 'share' | 'show' | 'sort-alpha' | 'speech' | 'spinner-step-1' | 'spinner-step-2' | 'spinner-step-3' | 'spinner-step-4' | 'spreadsheet' | 'stop-circle' | 'tick' | 'transcript' | 'upload' | 'users' | 'video' | 'view-all' | 'wheelchair' | 'x' | 'youtube' | 'zoom'" }, "description": "Name of the icon for the card (used for \"leading-icon\" and \"stacked-icon\" variants). Refer qgds-icon for available icons.", "attribute": "icon-name" }, { "kind": "field", "name": "imageAlt", "type": { "text": "string" }, "description": "The alternative text for the card's image", "attribute": "image-alt" }, { "kind": "field", "name": "imagePosition", "type": { "text": "'none' | 'start' | 'end'" }, "default": "\"start\"", "description": "Position of the image for feature variant cards (start or end).", "attribute": "image-position" }, { "kind": "field", "name": "imageSrc", "type": { "text": "string" }, "description": "The source URL for the card's image", "attribute": "image-src" }, { "kind": "field", "name": "layout", "type": { "text": "'default' | 'feature'" }, "default": "\"default\"", "description": "Spatial layout of the card: \"default\" (standard stacked layout) or \"feature\" (side-by-side image/content layout at larger viewports).", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "palette", "type": { "text": "string" }, "default": "\"default\"", "description": "Colour palette applied to the card.", "attribute": "palette", "reflects": true }, { "kind": "field", "name": "target", "type": { "text": "string" }, "default": "\"_self\"", "description": "Link target for single-action cards.", "attribute": "target" }, { "kind": "field", "name": "variant", "type": { "text": "'none' | 'arrow' | 'leading-icon' | 'stacked-icon'" }, "default": "\"none\"", "description": "Alternate card variants: \"arrow\", \"leading-icon\", or \"stacked-icon\".", "attribute": "variant", "reflects": true } ], "events": [ { "description": "Fires when the card region is clicked.", "name": "qgds-click" } ], "attributes": [ { "name": "action", "type": { "text": "'none' | 'single' | 'multiple'" }, "default": "\"none\"", "description": "Card's primary behaviour: \"none\" (non-clickable), \"single\" (whole card is a link), \"multiple\" (independent footer links).", "fieldName": "action" }, { "name": "aria-label", "type": { "text": "string" }, "default": "null", "description": "Accessible name override when the heading is insufficient.", "fieldName": "ariaLabel" }, { "name": "heading", "type": { "text": "string" }, "default": "\"\"", "description": "The card's heading text.", "fieldName": "heading" }, { "name": "heading-level", "type": { "text": "'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h3\"", "description": "Semantic heading level (h2-h6).", "fieldName": "headingLevel" }, { "name": "href", "type": { "text": "string" }, "description": "URL for single-action cards, and primary link for multiple-action cards.", "fieldName": "href" }, { "name": "icon-name", "type": { "text": "'close' | 'search' | 'status-cancel' | 'status-danger' | 'status-error' | 'status-information' | 'status-maintenance' | 'status-success' | 'status-warning' | 'accessibility' | 'alert-cancel-filled' | 'alert-cancel' | 'alert-danger' | 'alert-error' | 'alert-information' | 'alert-maintenance' | 'alert-success' | 'alert-warning' | 'announcement' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'article' | 'attach' | 'audio' | 'calendar' | 'car' | 'chart' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clock' | 'code' | 'copy' | 'cost-money' | 'delete' | 'design' | 'direction-up-down' | 'directions' | 'document-error' | 'document-pdf' | 'document-spreadsheet' | 'document-word' | 'document' | 'download' | 'edit' | 'email' | 'enlarge' | 'external-link' | 'facebook' | 'favourite' | 'filter' | 'global-nav' | 'help' | 'hide' | 'home' | 'identity-face' | 'identity' | 'image' | 'instagram' | 'language' | 'like' | 'linkedin' | 'links' | 'location' | 'lock-open' | 'lock' | 'login' | 'logout' | 'manage-accounts' | 'menu' | 'microphone' | 'minus' | 'more-horizontal' | 'more-vertical' | 'notifications-circle' | 'notifications' | 'op-ed' | 'parking' | 'pause-circle' | 'pdf' | 'pending' | 'phone' | 'play-circle' | 'plus' | 'podcasts' | 'print' | 'profile' | 'refresh' | 'save' | 'settings' | 'share' | 'show' | 'sort-alpha' | 'speech' | 'spinner-step-1' | 'spinner-step-2' | 'spinner-step-3' | 'spinner-step-4' | 'spreadsheet' | 'stop-circle' | 'tick' | 'transcript' | 'upload' | 'users' | 'video' | 'view-all' | 'wheelchair' | 'x' | 'youtube' | 'zoom'" }, "description": "Name of the icon for the card (used for \"leading-icon\" and \"stacked-icon\" variants). Refer qgds-icon for available icons.", "fieldName": "iconName" }, { "name": "image-alt", "type": { "text": "string" }, "description": "The alternative text for the card's image", "fieldName": "imageAlt" }, { "name": "image-position", "type": { "text": "'none' | 'start' | 'end'" }, "default": "\"start\"", "description": "Position of the image for feature variant cards (start or end).", "fieldName": "imagePosition" }, { "name": "image-src", "type": { "text": "string" }, "description": "The source URL for the card's image", "fieldName": "imageSrc" }, { "name": "layout", "type": { "text": "'default' | 'feature'" }, "default": "\"default\"", "description": "Spatial layout of the card: \"default\" (standard stacked layout) or \"feature\" (side-by-side image/content layout at larger viewports).", "fieldName": "layout" }, { "name": "palette", "type": { "text": "string" }, "default": "\"default\"", "description": "Colour palette applied to the card.", "fieldName": "palette" }, { "name": "target", "type": { "text": "string" }, "default": "\"_self\"", "description": "Link target for single-action cards.", "fieldName": "target" }, { "name": "variant", "type": { "text": "'none' | 'arrow' | 'leading-icon' | 'stacked-icon'" }, "default": "\"none\"", "description": "Alternate card variants: \"arrow\", \"leading-icon\", or \"stacked-icon\".", "fieldName": "variant" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/fc8Ng3GB7fbkL37WGKXwai/Queensland-Government-Design-System--UI-Kit--Community-\\?node-id\\=120360-98159\\&m\\=dev", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/card", "description": "" }, "tagName": "qgds-card", "customElement": true } ], "exports": [ { "kind": "js", "name": "IconName", "declaration": { "name": "IconName", "module": "src/components/qgds-card/qgds-card.ts" } }, { "kind": "custom-element-definition", "name": "qgds-card", "declaration": { "name": "QGDSCard", "module": "src/components/qgds-card/qgds-card.ts" } }, { "kind": "js", "name": "QGDSCard", "declaration": { "name": "QGDSCard", "module": "src/components/qgds-card/qgds-card.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-details/qgds-details.ts", "declarations": [ { "kind": "class", "description": "Used to progressively disclose content behind a native browser details/summary disclosure widget.", "name": "QGDSDetails", "cssProperties": [ { "type": { "text": "color" }, "description": "Override the summary text color.", "name": "--summary-color" }, { "type": { "text": "color" }, "description": "Override the chevron icon color.", "name": "--summary-icon-color" }, { "type": { "text": "color" }, "description": "Override the summary hover background color.", "name": "--summary-bg-hover" }, { "type": { "text": "color" }, "description": "Override the chevron icon color on hover.", "name": "--summary-icon-hover" }, { "type": { "text": "color" }, "description": "Override the content text color.", "name": "--content-color" } ], "slots": [ { "description": "Default slot accepts general typographic HTML content (paragraphs, lists, links).", "name": "" } ], "members": [ { "kind": "field", "name": "ariaLabel", "type": { "text": "string | null" }, "default": "null", "attribute": "aria-label" }, { "kind": "field", "name": "size", "type": { "text": "'sm' | 'md' | 'lg' | 'xl'" }, "default": "\"sm\"", "description": "Size variant controlling height and font size (\"sm\", \"md\", \"lg\", \"xl\"). Default is \"sm\".", "attribute": "size", "reflects": true }, { "type": { "text": "string" }, "description": "The visible label shown in the summary trigger.", "name": "summary-text", "kind": "field" }, { "kind": "field", "name": "summaryText", "type": { "text": "string" }, "default": "\"Summary\"", "attribute": "summary-text" } ], "events": [ { "description": "Emitted when the details is toggled open or closed. Event payload includes `{ component: \"qgds-details\", id: string | null, open: boolean }`.", "name": "qgds-toggle" } ], "attributes": [ { "name": "aria-label", "type": { "text": "string | null" }, "default": "null", "fieldName": "ariaLabel" }, { "name": "size", "type": { "text": "'sm' | 'md' | 'lg' | 'xl'" }, "default": "\"sm\"", "description": "Size variant controlling height and font size (\"sm\", \"md\", \"lg\", \"xl\"). Default is \"sm\".", "fieldName": "size" }, { "name": "summary-text", "type": { "text": "string" }, "default": "\"Summary\"", "fieldName": "summaryText" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit", "description": "" }, "tagName": "qgds-details", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-details", "declaration": { "name": "QGDSDetails", "module": "src/components/qgds-details/qgds-details.ts" } }, { "kind": "js", "name": "QGDSDetails", "declaration": { "name": "QGDSDetails", "module": "src/components/qgds-details/qgds-details.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-direction-link/qgds-direction-link.ts", "declarations": [ { "kind": "class", "description": "A direction link component that wraps `` with a fixed directional arrow icon.", "name": "QGDSDirectionLink", "members": [ { "kind": "field", "name": "animation", "type": { "text": "boolean" }, "default": "true", "description": "When true (default), animates the arrow in the matching direction. Set to false to disable.", "attribute": "animation", "reflects": true }, { "kind": "field", "name": "direction", "type": { "text": "'left' | 'right' | 'up' | 'down'" }, "default": "\"right\"", "description": "The arrow direction (\"up\", \"down\", \"left\", \"right\"). Defaults to \"right\".", "attribute": "direction", "reflects": true }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "\"\"", "description": "The destination URL.", "attribute": "href" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "The visible link label text.", "attribute": "label" } ], "attributes": [ { "name": "animation", "type": { "text": "boolean" }, "default": "true", "description": "When true (default), animates the arrow in the matching direction. Set to false to disable.", "fieldName": "animation" }, { "name": "direction", "type": { "text": "'left' | 'right' | 'up' | 'down'" }, "default": "\"right\"", "description": "The arrow direction (\"up\", \"down\", \"left\", \"right\"). Defaults to \"right\".", "fieldName": "direction" }, { "name": "href", "type": { "text": "string" }, "default": "\"\"", "description": "The destination URL.", "fieldName": "href" }, { "name": "label", "type": { "text": "string" }, "default": "\"\"", "description": "The visible link label text.", "fieldName": "label" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit", "description": "" }, "tagName": "qgds-direction-link", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-direction-link", "declaration": { "name": "QGDSDirectionLink", "module": "src/components/qgds-direction-link/qgds-direction-link.ts" } }, { "kind": "js", "name": "QGDSDirectionLink", "declaration": { "name": "QGDSDirectionLink", "module": "src/components/qgds-direction-link/qgds-direction-link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-feature-icon/qgds-feature-icon.ts", "declarations": [ { "kind": "class", "description": "QGDS Feature Icon Component\n\nA web component for displaying feature icons in the Queensland Government Design System (QGDS). This component uses the QGDS Icon component to render icons based on the provided icon name and size.", "name": "QGDSFeatureIcon", "members": [ { "kind": "field", "name": "iconName", "type": { "text": "string" }, "description": "The name of the icon to display (e.g., \"home\", \"alert-success\")", "attribute": "icon-name" }, { "kind": "field", "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"sm\"", "description": "The size of the feature icon. Options are \"sm\" (small) and \"lg\" (large). Default is \"sm\".", "attribute": "size", "reflects": true } ], "attributes": [ { "name": "icon-name", "type": { "text": "string" }, "description": "The name of the icon to display (e.g., \"home\", \"alert-success\")", "fieldName": "iconName" }, { "name": "size", "type": { "text": "\"sm\" | \"lg\"" }, "default": "\"sm\"", "description": "The size of the feature icon. Options are \"sm\" (small) and \"lg\" (large). Default is \"sm\".", "fieldName": "size" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/APANArEk8nHGbgQk12sR7a/Queensland-Government-Design-System--UI-Kit--Community-?node-id=9652-250374", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/styles/iconography", "description": "" }, "tagName": "qgds-feature-icon", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-feature-icon", "declaration": { "name": "QGDSFeatureIcon", "module": "src/components/qgds-feature-icon/qgds-feature-icon.ts" } }, { "kind": "js", "name": "QGDSFeatureIcon", "declaration": { "name": "QGDSFeatureIcon", "module": "src/components/qgds-feature-icon/qgds-feature-icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-icon/qgds-icon.ts", "declarations": [ { "kind": "class", "description": "QGDS Icon Component\n\nA web component for displaying icons using CSS mask-image or background-image techniques.\nSingle-colour icons use mask-image for easy recolouring via CSS.\nMulti-colour icons use background-image to preserve their original colours.", "name": "QGDSIcon", "cssProperties": [ { "description": "The color of single-colour icons (applies to mask-image icons).", "name": "--qgds-icon-color" }, { "description": "The size of the icon.", "name": "--qgds-icon-size" } ], "members": [ { "kind": "field", "name": "ariaLabel", "type": { "text": "string" }, "default": "\"\"", "attribute": "aria-label" }, { "kind": "field", "name": "iconId", "type": { "text": "'close' | 'search' | 'status-cancel' | 'status-danger' | 'status-error' | 'status-information' | 'status-maintenance' | 'status-success' | 'status-warning' | 'accessibility' | 'alert-cancel-filled' | 'alert-cancel' | 'alert-danger' | 'alert-error' | 'alert-information' | 'alert-maintenance' | 'alert-success' | 'alert-warning' | 'announcement' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'article' | 'attach' | 'audio' | 'calendar' | 'car' | 'chart' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clock' | 'code' | 'copy' | 'cost-money' | 'delete' | 'design' | 'direction-up-down' | 'directions' | 'document-error' | 'document-pdf' | 'document-spreadsheet' | 'document-word' | 'document' | 'download' | 'edit' | 'email' | 'enlarge' | 'external-link' | 'facebook' | 'favourite' | 'filter' | 'global-nav' | 'help' | 'hide' | 'home' | 'identity-face' | 'identity' | 'image' | 'instagram' | 'language' | 'like' | 'linkedin' | 'links' | 'location' | 'lock-open' | 'lock' | 'login' | 'logout' | 'manage-accounts' | 'menu' | 'microphone' | 'minus' | 'more-horizontal' | 'more-vertical' | 'notifications-circle' | 'notifications' | 'op-ed' | 'parking' | 'pause-circle' | 'pdf' | 'pending' | 'phone' | 'play-circle' | 'plus' | 'podcasts' | 'print' | 'profile' | 'refresh' | 'save' | 'settings' | 'share' | 'show' | 'sort-alpha' | 'speech' | 'spinner-step-1' | 'spinner-step-2' | 'spinner-step-3' | 'spinner-step-4' | 'spreadsheet' | 'stop-circle' | 'tick' | 'transcript' | 'upload' | 'users' | 'video' | 'view-all' | 'wheelchair' | 'x' | 'youtube' | 'zoom' | undefined" }, "attribute": "icon-id" }, { "kind": "field", "name": "size", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'" }, "default": "\"md\"", "attribute": "size" } ], "attributes": [ { "type": { "text": "string" }, "description": "The aria-label for the icon for accessibility.", "name": "aria-label", "default": "\"\"", "fieldName": "ariaLabel" }, { "type": { "text": "'close' | 'search' | 'status-cancel' | 'status-danger' | 'status-error' | 'status-information' | 'status-maintenance' | 'status-success' | 'status-warning' | 'accessibility' | 'alert-cancel-filled' | 'alert-cancel' | 'alert-danger' | 'alert-error' | 'alert-information' | 'alert-maintenance' | 'alert-success' | 'alert-warning' | 'announcement' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'article' | 'attach' | 'audio' | 'calendar' | 'car' | 'chart' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clock' | 'code' | 'copy' | 'cost-money' | 'delete' | 'design' | 'direction-up-down' | 'directions' | 'document-error' | 'document-pdf' | 'document-spreadsheet' | 'document-word' | 'document' | 'download' | 'edit' | 'email' | 'enlarge' | 'external-link' | 'facebook' | 'favourite' | 'filter' | 'global-nav' | 'help' | 'hide' | 'home' | 'identity-face' | 'identity' | 'image' | 'instagram' | 'language' | 'like' | 'linkedin' | 'links' | 'location' | 'lock-open' | 'lock' | 'login' | 'logout' | 'manage-accounts' | 'menu' | 'microphone' | 'minus' | 'more-horizontal' | 'more-vertical' | 'notifications-circle' | 'notifications' | 'op-ed' | 'parking' | 'pause-circle' | 'pdf' | 'pending' | 'phone' | 'play-circle' | 'plus' | 'podcasts' | 'print' | 'profile' | 'refresh' | 'save' | 'settings' | 'share' | 'show' | 'sort-alpha' | 'speech' | 'spinner-step-1' | 'spinner-step-2' | 'spinner-step-3' | 'spinner-step-4' | 'spreadsheet' | 'stop-circle' | 'tick' | 'transcript' | 'upload' | 'users' | 'video' | 'view-all' | 'wheelchair' | 'x' | 'youtube' | 'zoom' | undefined" }, "description": "The ID of the icon to display (e.g., \"home\", \"alert-success\").", "name": "icon-id", "fieldName": "iconId" }, { "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'" }, "description": "The size of the icon. Options are \"xs\", \"sm\", \"md\", \"lg\", \"xl\", \"xxl\". Default is \"md\".", "name": "size", "default": "\"md\"", "fieldName": "size" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/0mkS2SvlrITvPC4JTnF7RS/QGDS-Icon-library", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/styles/iconography", "description": "" }, "tagName": "qgds-icon", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-icon", "declaration": { "name": "QGDSIcon", "module": "src/components/qgds-icon/qgds-icon.ts" } }, { "kind": "js", "name": "QGDSIcon", "declaration": { "name": "QGDSIcon", "module": "src/components/qgds-icon/qgds-icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-image/qgds-image.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSImage", "members": [ { "kind": "field", "name": "align", "type": { "text": "\"left\" | \"right\" | undefined" }, "attribute": "align" }, { "kind": "field", "name": "alt", "type": { "text": "string" }, "default": "\"\"", "attribute": "alt", "reflects": true }, { "kind": "field", "name": "ariaDescribedby", "type": { "text": "string | undefined" }, "attribute": "aria-describedby" }, { "kind": "field", "name": "ariaLabel", "type": { "text": "string | null" }, "default": "null", "attribute": "aria-label" }, { "kind": "field", "name": "aspect", "type": { "text": "'16:9' | '9:16' | '2:1' | '1:2' | '3:2' | '2:3' | '4:3' | '3:4' | '1:1' | undefined" }, "attribute": "aspect", "reflects": true }, { "kind": "field", "name": "caption", "type": { "text": "string | undefined" }, "default": "\"\"", "attribute": "caption" }, { "kind": "field", "name": "decoding", "type": { "text": "\"async\" | \"sync\" | \"auto\" | undefined" }, "attribute": "decoding" }, { "kind": "field", "name": "decorative", "type": { "text": "boolean" }, "default": "false", "attribute": "decorative" }, { "kind": "field", "name": "fetchpriority", "type": { "text": "\"high\" | \"low\" | \"auto\" | undefined" }, "attribute": "fetchpriority" }, { "kind": "field", "name": "height", "type": { "text": "number" }, "default": "0", "attribute": "height" }, { "kind": "field", "name": "hotspot", "type": { "text": "string | undefined" }, "attribute": "hotspot" }, { "kind": "field", "name": "loading", "type": { "text": "\"lazy\" | \"eager\" | undefined" }, "attribute": "loading" }, { "kind": "field", "name": "referrerpolicy", "type": { "text": "'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url' | undefined" }, "attribute": "referrerpolicy" }, { "kind": "field", "name": "sizes", "type": { "text": "string | undefined" }, "attribute": "sizes" }, { "kind": "field", "name": "src", "type": { "text": "string" }, "default": "\"\"", "attribute": "src", "reflects": true }, { "kind": "field", "name": "srcset", "type": { "text": "string | undefined" }, "attribute": "srcset" }, { "kind": "field", "name": "width", "type": { "text": "number" }, "default": "0", "attribute": "width" } ], "attributes": [ { "name": "align", "type": { "text": "\"left\" | \"right\" | undefined" }, "fieldName": "align" }, { "name": "alt", "type": { "text": "string" }, "default": "\"\"", "fieldName": "alt" }, { "name": "aria-describedby", "type": { "text": "string | undefined" }, "fieldName": "ariaDescribedby" }, { "name": "aria-label", "type": { "text": "string | null" }, "default": "null", "fieldName": "ariaLabel" }, { "name": "aspect", "type": { "text": "'16:9' | '9:16' | '2:1' | '1:2' | '3:2' | '2:3' | '4:3' | '3:4' | '1:1' | undefined" }, "fieldName": "aspect" }, { "name": "caption", "type": { "text": "string | undefined" }, "default": "\"\"", "fieldName": "caption" }, { "name": "decoding", "type": { "text": "\"async\" | \"sync\" | \"auto\" | undefined" }, "fieldName": "decoding" }, { "name": "decorative", "type": { "text": "boolean" }, "default": "false", "fieldName": "decorative" }, { "name": "fetchpriority", "type": { "text": "\"high\" | \"low\" | \"auto\" | undefined" }, "fieldName": "fetchpriority" }, { "name": "height", "type": { "text": "number" }, "default": "0", "fieldName": "height" }, { "name": "hotspot", "type": { "text": "string | undefined" }, "fieldName": "hotspot" }, { "name": "loading", "type": { "text": "\"lazy\" | \"eager\" | undefined" }, "fieldName": "loading" }, { "name": "referrerpolicy", "type": { "text": "'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url' | undefined" }, "fieldName": "referrerpolicy" }, { "name": "sizes", "type": { "text": "string | undefined" }, "fieldName": "sizes" }, { "name": "src", "type": { "text": "string" }, "default": "\"\"", "fieldName": "src" }, { "name": "srcset", "type": { "text": "string | undefined" }, "fieldName": "srcset" }, { "name": "width", "type": { "text": "number" }, "default": "0", "fieldName": "width" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-image", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-image", "declaration": { "name": "QGDSImage", "module": "src/components/qgds-image/qgds-image.ts" } }, { "kind": "js", "name": "QGDSImage", "declaration": { "name": "QGDSImage", "module": "src/components/qgds-image/qgds-image.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-inpage-alert/qgds-inpage-alert.ts", "declarations": [ { "kind": "class", "description": "QGDS in-page alert\nIn-page alerts are a helpful tool for informing users about essential updates or modifications on a webpage, all while capturing their attention without disrupting their ongoing task. Usually positioned at the top of a page after a submit action, these alerts are designed to be noticeable yet unobtrusive.", "name": "QGDSInpageAlert", "cssProperties": [ { "description": "Override the color of the displayed icon", "name": "--icon-fg" }, { "description": "Override the color of the background.", "name": "--bg" }, { "description": "Override the border color.", "name": "--border" }, { "description": "Override the border width.", "name": "--border-width" } ], "slots": [ { "description": "Default content slot.", "name": "" } ], "members": [ { "kind": "field", "name": "heading", "type": { "text": "string" }, "description": "The alert heading text.", "attribute": "heading" }, { "kind": "field", "name": "headingLevel", "type": { "text": "2 | 3 | 4 | 5 | 6" }, "default": "3", "description": "Determines the heading level (h2-h6)", "attribute": "heading-level" }, { "kind": "field", "name": "variant", "type": { "text": "'success' | 'error' | 'info' | 'warning'" }, "default": "\"info\"", "description": "The alert variant, either \"error\", \"info\", \"success\", \"warning\".", "attribute": "variant" } ], "attributes": [ { "name": "heading", "type": { "text": "string" }, "description": "The alert heading text.", "fieldName": "heading" }, { "name": "heading-level", "type": { "text": "2 | 3 | 4 | 5 | 6" }, "default": "3", "description": "Determines the heading level (h2-h6)", "fieldName": "headingLevel" }, { "name": "variant", "type": { "text": "'success' | 'error' | 'info' | 'warning'" }, "default": "\"info\"", "description": "The alert variant, either \"error\", \"info\", \"success\", \"warning\".", "fieldName": "variant" } ], "superclass": { "name": "LitElement", "package": "lit" }, "uikit": { "name": "https://www.figma.com/design/qKsxl3ogIlBp7dafgxXuCA/QGDS-UI-kit?node-id=5990-98125&p=f&t=t7qJTAaoKBjwJfej-0", "description": "" }, "website": { "name": "https://www.designsystem.qld.gov.au/components/in-page-alert", "description": "" }, "tagName": "qgds-inpage-alert", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-inpage-alert", "declaration": { "name": "QGDSInpageAlert", "module": "src/components/qgds-inpage-alert/qgds-inpage-alert.ts" } }, { "kind": "js", "name": "QGDSInpageAlert", "declaration": { "name": "QGDSInpageAlert", "module": "src/components/qgds-inpage-alert/qgds-inpage-alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-inpage-nav/qgds-inpage-nav-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "QGDSInpageNavItem", "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "\"\"", "attribute": "href" } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "\"\"", "fieldName": "href" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-inpage-nav-item", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-inpage-nav-item", "declaration": { "name": "QGDSInpageNavItem", "module": "src/components/qgds-inpage-nav/qgds-inpage-nav-item.ts" } }, { "kind": "js", "name": "QGDSInpageNavItem", "declaration": { "name": "QGDSInpageNavItem", "module": "src/components/qgds-inpage-nav/qgds-inpage-nav-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-inpage-nav/qgds-inpage-nav.ts", "declarations": [ { "kind": "class", "description": "QGDS In-page Navigation Web Component\nIn-page navigation is a vertical list of links that helps users scan the contents of a page and navigate to different sections of the page", "name": "QGDSInpageNav", "members": [ { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "\"On this page\"", "attribute": "heading" }, { "kind": "field", "name": "headingLevel", "type": { "text": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h2\"", "attribute": "heading-level" }, { "kind": "field", "name": "isOrdered", "type": { "text": "boolean" }, "default": "false", "attribute": "is-ordered" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "\"On this page navigation\"", "attribute": "aria-label" } ], "attributes": [ { "description": "Accessible label for the navigation landmark, defaults to \"On this page navigation\"", "name": "aria-label", "type": { "text": "string" }, "default": "\"On this page navigation\"", "fieldName": "label" }, { "description": "Navigation heading text", "name": "heading", "type": { "text": "string" }, "default": "\"On this page\"", "fieldName": "heading" }, { "description": "Semantic heading level (h1-h6)", "name": "heading-level", "type": { "text": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "\"h2\"", "fieldName": "headingLevel" }, { "description": "Whether to use an ordered list (ol) instead of unordered (ul)", "name": "is-ordered", "type": { "text": "boolean" }, "default": "false", "fieldName": "isOrdered" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "qgds-inpage-nav", "customElement": true } ], "exports": [ { "kind": "custom-element-definition", "name": "qgds-inpage-nav", "declaration": { "name": "QGDSInpageNav", "module": "src/components/qgds-inpage-nav/qgds-inpage-nav.ts" } }, { "kind": "js", "name": "QGDSInpageNav", "declaration": { "name": "QGDSInpageNav", "module": "src/components/qgds-inpage-nav/qgds-inpage-nav.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/qgds-link-column/qgds-link-column.ts", "declarations": [ { "kind": "class", "description": "A navigation landmark that organises a set of `` elements into a titled column.\nSupports vertical and horizontal layouts, multi-column grids, and an optional view-all CTA.", "name": "QGDSLinkColumn", "cssProperties": [ { "type": { "text": "length|string" }, "description": "Override icon spacing at the start.", "name": "--qgds-icon-spacing-start" }, { "type": { "text": "length|string" }, "description": "Override icon spacing at the end.", "name": "--qgds-icon-spacing-end" }, { "type": { "text": "length|string" }, "description": "Override icon inline-start margin.", "name": "--qgds-icon-margin-start" } ], "slots": [ { "description": "Accepts `` elements only. Non-conforming children are hidden with a console warning.", "name": "" } ], "members": [ { "type": { "text": "string" }, "description": "Accessible label for the `