@primevue/mcp 4.5.5 → 5.0.0-rc.2

package/data/llms/components/inputtext.md

@@ -0,0 +1,569 @@
+# InputText
+
+InputText is an extension to standard input element with icons and theming.
+
+## Basic
+
+InputText is used with the v-model property for two-way value binding.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <InputText type="text" v-model="value" placeholder="Enter text" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Clear Icon
+
+Combine InputText with IconField to display a clear icon that resets the value when clicked.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <IconField>
+            <InputText v-model="value" class="w-56" placeholder="Type something" />
+            <InputIcon v-if="value" class="cursor-pointer" @click="value = ''">
+                <Times />
+            </InputIcon>
+        </IconField>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+import Times from '@primeicons/vue/times';
+
+const value = ref('');
+<\/script>
+```
+
+## Sizes
+
+InputText provides small and large sizes as alternatives to the standard.
+
+```vue
+<template>
+    <div class="flex flex-col items-center gap-4">
+        <InputText v-model="value1" type="text" size="small" placeholder="Small" />
+        <InputText v-model="value2" type="text" placeholder="Normal" />
+        <InputText v-model="value3" type="text" size="large" placeholder="Large" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value1 = ref(null);
+const value2 = ref(null);
+const value3 = ref(null);
+<\/script>
+```
+
+## Filled
+
+Specify the variant property as filled to display the component with a higher visual emphasis than the default outlined style.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <InputText v-model="value" type="text" variant="filled" placeholder="Enter text" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Invalid
+
+The invalid state is applied using the invalid property to indicate failed validation, which can be integrated with form validation.
+
+```vue
+<template>
+    <div class="flex flex-wrap justify-center gap-4">
+        <InputText v-model="value1" :invalid="!value1" placeholder="Enter text" />
+        <InputText v-model="value2" :invalid="!value2" variant="filled" placeholder="Enter text" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value1 = ref('');
+const value2 = ref('');
+<\/script>
+```
+
+## Disabled
+
+When disabled is present, the element cannot be edited and focused.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <InputText v-model="value" disabled placeholder="Disabled" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Float Label
+
+FloatLabel visually integrates a label with its form element. Visit FloatLabel documentation for more information.
+
+```vue
+<template>
+    <div class="flex flex-wrap justify-center items-end gap-4">
+        <FloatLabel>
+            <InputText id="over_label" v-model="value1" />
+            <label for="over_label">Over Label</label>
+        </FloatLabel>
+
+        <FloatLabel variant="in">
+            <InputText id="in_label" v-model="value2" />
+            <label for="in_label">In Label</label>
+        </FloatLabel>
+
+        <FloatLabel variant="on">
+            <InputText id="on_label" v-model="value3" />
+            <label for="on_label">On Label</label>
+        </FloatLabel>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value1 = ref(null);
+const value2 = ref(null);
+const value3 = ref(null);
+<\/script>
+```
+
+## Ifta Label
+
+IftaLabel is used to create infield top aligned labels. Visit IftaLabel documentation for more information.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <IftaLabel>
+            <InputText id="username" v-model="value" />
+            <label for="username">Username</label>
+        </IftaLabel>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Fluid
+
+The fluid prop makes the component take up the full width of its container when set to true.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <InputText type="text" v-model="value" fluid />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Help Text
+
+An advisory text can be defined with the semantic small tag.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <div class="flex flex-col gap-2">
+            <Label for="username">Username</Label>
+            <InputText id="username" v-model="value" aria-describedby="username-help" />
+            <small id="username-help" class="text-sm">Enter your username to reset your password.</small>
+        </div>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const value = ref(null);
+<\/script>
+```
+
+## Forms
+
+InputText integrates seamlessly with the PrimeVue Forms library.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex flex-col gap-4 w-full sm:w-56">
+            <div class="flex flex-col gap-1">
+                <InputText name="username" type="text" placeholder="Username" fluid />
+                <Message v-if="$form.username?.invalid" severity="error" size="small" variant="simple">{{ $form.username.error?.message }}</Message>
+            </div>
+            <div class="flex flex-col gap-1">
+                <InputText name="email" type="text" placeholder="Email" fluid />
+                <Message v-if="$form.email?.invalid" severity="error" size="small" variant="simple">{{ $form.email.error?.message }}</Message>
+            </div>
+            <Button type="submit" severity="secondary">Submit</Button>
+        </Form>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+import { zodResolver } from '@primevue/forms/resolvers/zod';
+import { useToast } from "primevue/usetoast";
+import { z } from 'zod';
+
+const toast = useToast();
+const initialValues = ref({
+    username: '',
+    email: ''
+});
+
+const resolver = ref(zodResolver(
+    z.object({
+        username: z.string().min(1, { message: 'Username is required.' }),
+        email: z.string().min(1, { message: 'Email is required.' }).email({ message: 'Invalid email address.' })
+    })
+));
+
+const onFormSubmit = ({ valid }) => {
+    if (valid) {
+        toast.add({ severity: 'success', summary: 'Form is submitted.', life: 3000 });
+    }
+};
+<\/script>
+```
+
+## Accessibility
+
+Screen Reader InputText component renders a native input element that implicitly includes any passed prop. Value to describe the component can either be provided via label tag combined with id prop or using aria-labelledby , aria-label props. Keyboard Support Key Function tab Moves focus to the input.
+
+```vue
+<template>
+    <label for="firstname">Firstname</label>
+    <InputText id="firstname" />
+
+    <span id="lastname">Lastname</span>
+    <InputText aria-labelledby="lastname" />
+
+    <InputText aria-label="Age"/>
+</template>
+```
+
+## Input Text API
+
+### Props
+
+| Name |Type |Default |Description |
+| --- | --- | --- | --- |
+| aria-activedescendant | string | - | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
+| aria-atomic | Booleanish | - | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
+| aria-autocomplete | "none" \| "inline" \| "list" \| "both" | - | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. |
+| aria-busy | Booleanish | - | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. |
+| aria-checked | Booleanish \| "mixed" | - | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
+| aria-colcount | Numberish | - | Defines the total number of columns in a table, grid, or treegrid. |
+| aria-colindex | Numberish | - | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
+| aria-colspan | Numberish | - | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
+| aria-controls | string | - | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
+| aria-current | Booleanish \| "page" \| "step" \| "location" \| "date" \| "time" | - | Indicates the element that represents the current item within a container or set of related elements. |
+| aria-describedby | string | - | Identifies the element (or elements) that describes the object. |
+| aria-details | string | - | Identifies the element that provides a detailed, extended description for the object. |
+| aria-disabled | Booleanish | - | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
+| aria-dropeffect | "link" \| "none" \| "copy" \| "execute" \| "move" \| "popup" | - | Indicates what functions can be performed when a dragged object is released on the drop target. |
+| aria-errormessage | string | - | Identifies the element that provides an error message for the object. |
+| aria-expanded | Booleanish | - | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
+| aria-flowto | string | - | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. |
+| aria-grabbed | Booleanish | - | Indicates an element's "grabbed" state in a drag-and-drop operation. |
+| aria-haspopup | Booleanish \| "menu" \| "listbox" \| "tree" \| "grid" \| "dialog" | - | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
+| aria-hidden | Booleanish | - | Indicates whether the element is exposed to an accessibility API. |
+| aria-invalid | Booleanish \| "grammar" \| "spelling" | - | Indicates the entered value does not conform to the format expected by the application. |
+| aria-keyshortcuts | string | - | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
+| aria-label | string | - | Defines a string value that labels the current element. |
+| aria-labelledby | string | - | Identifies the element (or elements) that labels the current element. |
+| aria-level | Numberish | - | Defines the hierarchical level of an element within a structure. |
+| aria-live | "off" \| "assertive" \| "polite" | - | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
+| aria-modal | Booleanish | - | Indicates whether an element is modal when displayed. |
+| aria-multiline | Booleanish | - | Indicates whether a text box accepts multiple lines of input or only a single line. |
+| aria-multiselectable | Booleanish | - | Indicates that the user may select more than one item from the current selectable descendants. |
+| aria-orientation | "horizontal" \| "vertical" | - | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
+| aria-owns | string | - | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. |
+| aria-placeholder | string | - | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. |
+| aria-posinset | Numberish | - | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
+| aria-pressed | Booleanish \| "mixed" | - | Indicates the current "pressed" state of toggle buttons. |
+| aria-readonly | Booleanish | - | Indicates that the element is not editable, but is otherwise operable. |
+| aria-relevant | "text" \| "additions" \| "additions removals" \| "additions text" \| "all" \| "removals" \| "removals additions" \| "removals text" \| "text additions" \| "text removals" | - | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. |
+| aria-required | Booleanish | - | Indicates that user input is required on the element before a form may be submitted. |
+| aria-roledescription | string | - | Defines a human-readable, author-localized description for the role of an element. |
+| aria-rowcount | Numberish | - | Defines the total number of rows in a table, grid, or treegrid. |
+| aria-rowindex | Numberish | - | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
+| aria-rowspan | Numberish | - | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
+| aria-selected | Booleanish | - | Indicates the current "selected" state of various widgets. |
+| aria-setsize | Numberish | - | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
+| aria-sort | "none" \| "ascending" \| "descending" \| "other" | - | Indicates if items in a table or grid are sorted in ascending or descending order. |
+| aria-valuemax | Numberish | - | Defines the maximum allowed value for a range widget. |
+| aria-valuemin | Numberish | - | Defines the minimum allowed value for a range widget. |
+| aria-valuenow | Numberish | - | Defines the current value for a range widget. |
+| aria-valuetext | string | - | Defines the human readable text alternative of aria-valuenow for a range widget. |
+| innerHTML | string | - |  |
+| class | ClassValue | - |  |
+| style | StyleValue | - |  |
+| accesskey | string | - |  |
+| contenteditable | Booleanish \| "inherit" \| "plaintext-only" | - |  |
+| contextmenu | string | - |  |
+| dir | string | - |  |
+| draggable | Booleanish | - |  |
+| enterkeyhint | "enter" \| "done" \| "go" \| "next" \| "previous" \| "search" \| "send" | - |  |
+| enterKeyHint | "enter" \| "done" \| "go" \| "next" \| "previous" \| "search" \| "send" | - |  |
+| hidden | "" \| Booleanish \| "hidden" \| "until-found" | - |  |
+| id | string | - |  |
+| inert | Booleanish | - |  |
+| lang | string | - |  |
+| spellcheck | Booleanish | - |  |
+| tabindex | Numberish | - |  |
+| title | string | - |  |
+| translate | "yes" \| "no" | - |  |
+| radiogroup | string | - |  |
+| role | string | - |  |
+| about | string | - |  |
+| datatype | string | - |  |
+| inlist | any | - |  |
+| prefix | string | - |  |
+| property | string | - |  |
+| resource | string | - |  |
+| typeof | string | - |  |
+| vocab | string | - |  |
+| autocapitalize | string | - |  |
+| autocorrect | string | - |  |
+| autosave | string | - |  |
+| color | string | - |  |
+| itemprop | string | - |  |
+| itemscope | Booleanish | - |  |
+| itemtype | string | - |  |
+| itemid | string | - |  |
+| itemref | string | - |  |
+| results | Numberish | - |  |
+| security | string | - |  |
+| unselectable | "on" \| "off" | - |  |
+| inputmode | "text" \| "search" \| "none" \| "tel" \| "url" \| "email" \| "numeric" \| "decimal" | - | Hints at the type of data that might be entered by the user while editing the element or its contents |
+| is | string | - | Specify that a standard HTML element should behave like a defined custom built-in element |
+| exportparts | string | - |  |
+| part | string | - |  |
+| accept | string | - |  |
+| alt | string | - |  |
+| autocomplete | InputAutoCompleteAttribute | - |  |
+| autofocus | Booleanish | - |  |
+| capture | boolean \| "user" \| "environment" | - |  |
+| checked | any[] \| Set<any> \| Booleanish | - |  |
+| crossorigin | string | - |  |
+| disabled | Booleanish | - |  |
+| form | string | - |  |
+| formaction | string | - |  |
+| formenctype | string | - |  |
+| formmethod | string | - |  |
+| formnovalidate | Booleanish | - |  |
+| formtarget | string | - |  |
+| height | Numberish | - |  |
+| indeterminate | boolean | - |  |
+| list | string | - |  |
+| max | Numberish | - |  |
+| maxlength | Numberish | - |  |
+| min | Numberish | - |  |
+| minlength | Numberish | - |  |
+| multiple | Booleanish | - |  |
+| pattern | string | - |  |
+| placeholder | string | - |  |
+| readonly | Booleanish | - |  |
+| required | Booleanish | - |  |
+| src | string | - |  |
+| step | Numberish | - |  |
+| type | InputTypeHTMLAttribute | - |  |
+| value | any | - |  |
+| width | Numberish | - |  |
+| onCancel | Function | - |  |
+| onCopy | Function | - |  |
+| onCut | Function | - |  |
+| onPaste | Function | - |  |
+| onCompositionend | Function | - |  |
+| onCompositionstart | Function | - |  |
+| onCompositionupdate | Function | - |  |
+| onDrag | Function | - |  |
+| onDragend | Function | - |  |
+| onDragenter | Function | - |  |
+| onDragexit | Function | - |  |
+| onDragleave | Function | - |  |
+| onDragover | Function | - |  |
+| onDragstart | Function | - |  |
+| onDrop | Function | - |  |
+| onFocus | Function | - |  |
+| onFocusin | Function | - |  |
+| onFocusout | Function | - |  |
+| onBlur | Function | - |  |
+| onChange | Function | - |  |
+| onBeforeinput | Function | - |  |
+| onFormdata | Function | - |  |
+| onInput | Function | - |  |
+| onReset | Function | - |  |
+| onSubmit | Function | - |  |
+| onInvalid | Function | - |  |
+| onFullscreenchange | Function | - |  |
+| onFullscreenerror | Function | - |  |
+| onLoad | Function | - |  |
+| onError | Function | - |  |
+| onKeydown | Function | - |  |
+| onKeypress | Function | - |  |
+| onKeyup | Function | - |  |
+| onDblclick | Function | - |  |
+| onMousedown | Function | - |  |
+| onMouseenter | Function | - |  |
+| onMouseleave | Function | - |  |
+| onMousemove | Function | - |  |
+| onMouseout | Function | - |  |
+| onMouseover | Function | - |  |
+| onMouseup | Function | - |  |
+| onAbort | Function | - |  |
+| onCanplay | Function | - |  |
+| onCanplaythrough | Function | - |  |
+| onDurationchange | Function | - |  |
+| onEmptied | Function | - |  |
+| onEncrypted | Function | - |  |
+| onEnded | Function | - |  |
+| onLoadeddata | Function | - |  |
+| onLoadedmetadata | Function | - |  |
+| onLoadstart | Function | - |  |
+| onPause | Function | - |  |
+| onPlay | Function | - |  |
+| onPlaying | Function | - |  |
+| onProgress | Function | - |  |
+| onRatechange | Function | - |  |
+| onSeeked | Function | - |  |
+| onSeeking | Function | - |  |
+| onStalled | Function | - |  |
+| onSuspend | Function | - |  |
+| onTimeupdate | Function | - |  |
+| onVolumechange | Function | - |  |
+| onWaiting | Function | - |  |
+| onSelect | Function | - |  |
+| onScroll | Function | - |  |
+| onScrollend | Function | - |  |
+| onTouchcancel | Function | - |  |
+| onTouchend | Function | - |  |
+| onTouchmove | Function | - |  |
+| onTouchstart | Function | - |  |
+| onAuxclick | Function | - |  |
+| onClick | Function | - |  |
+| onContextmenu | Function | - |  |
+| onGotpointercapture | Function | - |  |
+| onLostpointercapture | Function | - |  |
+| onPointerdown | Function | - |  |
+| onPointermove | Function | - |  |
+| onPointerup | Function | - |  |
+| onPointercancel | Function | - |  |
+| onPointerenter | Function | - |  |
+| onPointerleave | Function | - |  |
+| onPointerover | Function | - |  |
+| onPointerout | Function | - |  |
+| onBeforetoggle | Function | - |  |
+| onToggle | Function | - |  |
+| onWheel | Function | - |  |
+| onAnimationcancel | Function | - |  |
+| onAnimationstart | Function | - |  |
+| onAnimationend | Function | - |  |
+| onAnimationiteration | Function | - |  |
+| onSecuritypolicyviolation | Function | - |  |
+| onTransitioncancel | Function | - |  |
+| onTransitionend | Function | - |  |
+| onTransitionrun | Function | - |  |
+| onTransitionstart | Function | - |  |
+| modelValue | Nullable<string> | - | Value of the component. |
+| defaultValue | Nullable<string> | - | The default value for the input when not controlled by  `modelValue` . |
+| name | string | - | The name attribute for the element, typically used in form submissions. |
+| size | null \| HintedString<"small" \| "large"> | - | Defines the size of the component. |
+| invalid | null \| boolean | false | When present, it specifies that the component should have invalid state style. |
+| variant | null \| HintedString<"outlined" \| "filled"> | null | Specifies the input variant of the component. |
+| fluid | null \| boolean | null | Spans 100% width of the container when enabled. |
+| formControl | Record<string, any> | - | Form control object, typically used for handling validation and form state. |
+| dt | any | - | It generates scoped CSS variables using design tokens for the component. |
+| pt | PassThrough<InputTextPassThroughOptions<any>> | - | Used to pass attributes to DOM elements inside the component. |
+| ptOptions | any | - | Used to configure passthrough(pt) options of the component. |
+| unstyled | boolean | false | When enabled, it removes component related styles in the core. |
+
+### Pass Through Options
+
+| Name |Type |Description |
+| --- | --- | --- |
+| root | InputTextPassThroughOptionType<T> | Used to pass attributes to the root's DOM element. |
+| hooks | any | Used to manage all lifecycle hooks. |
+
+### Theming
+
+### CSS Classes
+
+| Class |Description |
+| --- | --- |
+| p-inputtext | The class of root element |
+
+### Design Tokens
+
+| Token |CSS Variable |Description |
+| --- | --- | --- |
+| inputtext.background | --p-inputtext-background | Background of root |
+| inputtext.disabled.background | --p-inputtext-disabled-background | Disabled background of root |
+| inputtext.filled.background | --p-inputtext-filled-background | Filled background of root |
+| inputtext.filled.hover.background | --p-inputtext-filled-hover-background | Filled hover background of root |
+| inputtext.filled.focus.background | --p-inputtext-filled-focus-background | Filled focus background of root |
+| inputtext.border.color | --p-inputtext-border-color | Border color of root |
+| inputtext.hover.border.color | --p-inputtext-hover-border-color | Hover border color of root |
+| inputtext.focus.border.color | --p-inputtext-focus-border-color | Focus border color of root |
+| inputtext.invalid.border.color | --p-inputtext-invalid-border-color | Invalid border color of root |
+| inputtext.color | --p-inputtext-color | Color of root |
+| inputtext.disabled.color | --p-inputtext-disabled-color | Disabled color of root |
+| inputtext.placeholder.color | --p-inputtext-placeholder-color | Placeholder color of root |
+| inputtext.invalid.placeholder.color | --p-inputtext-invalid-placeholder-color | Invalid placeholder color of root |
+| inputtext.shadow | --p-inputtext-shadow | Shadow of root |
+| inputtext.padding.x | --p-inputtext-padding-x | Padding x of root |
+| inputtext.padding.y | --p-inputtext-padding-y | Padding y of root |
+| inputtext.border.radius | --p-inputtext-border-radius | Border radius of root |
+| inputtext.focus.ring.width | --p-inputtext-focus-ring-width | Focus ring width of root |
+| inputtext.focus.ring.style | --p-inputtext-focus-ring-style | Focus ring style of root |
+| inputtext.focus.ring.color | --p-inputtext-focus-ring-color | Focus ring color of root |
+| inputtext.focus.ring.offset | --p-inputtext-focus-ring-offset | Focus ring offset of root |
+| inputtext.focus.ring.shadow | --p-inputtext-focus-ring-shadow | Focus ring shadow of root |
+| inputtext.transition.duration | --p-inputtext-transition-duration | Transition duration of root |
+| inputtext.sm.font.size | --p-inputtext-sm-font-size | Sm font size of root |
+| inputtext.sm.padding.x | --p-inputtext-sm-padding-x | Sm padding x of root |
+| inputtext.sm.padding.y | --p-inputtext-sm-padding-y | Sm padding y of root |
+| inputtext.lg.font.size | --p-inputtext-lg-font-size | Lg font size of root |
+| inputtext.lg.padding.x | --p-inputtext-lg-padding-x | Lg padding x of root |
+| inputtext.lg.padding.y | --p-inputtext-lg-padding-y | Lg padding y of root |
+| inputtext.font.weight | --p-inputtext-font-weight | Font weight of root |
+| inputtext.font.size | --p-inputtext-font-size | Font size of root |

package/data/llms/components/installation.md

@@ -0,0 +1 @@
+# installation

package/data/llms/components/keyfilter.md

@@ -0,0 +1,116 @@
+# KeyFilter
+
+KeyFilter is a directive to restrict individual key strokes. In order to restrict the whole input, use InputNumber or InputMask instead.
+
+## Presets
+
+KeyFilter provides various presets configured with the v-keyfilter directive.
+
+```vue
+<template>
+    <div class="flex flex-wrap gap-4 mb-6">
+        <div class="flex-auto">
+            <Label for="integer" class="font-bold! block mb-2 "> Integer </Label>
+            <InputText id="integer" v-model="integer" v-keyfilter.int class="w-full" />
+        </div>
+        <div class="flex-auto">
+            <Label for="number" class="font-bold! block mb-2 "> Number </Label>
+            <InputText id="number" v-model="number" v-keyfilter.num class="w-full" />
+        </div>
+        <div class="flex-auto">
+            <Label for="money" class="font-bold! block mb-2 "> Money </Label>
+            <InputText id="money" v-model="money" v-keyfilter.money class="w-full" />
+        </div>
+    </div>
+    <div class="flex flex-wrap gap-4">
+        <div class="flex-auto">
+            <Label for="hex" class="font-bold! block mb-2 "> Hex </Label>
+            <InputText id="hex" v-model="hex" v-keyfilter.hex class="w-full" />
+        </div>
+        <div class="flex-auto">
+            <Label for="alphabetic" class="font-bold! block mb-2 "> Alphabetic </Label>
+            <InputText id="alphabetic" v-model="alphabetic" v-keyfilter.alpha class="w-full" />
+        </div>
+        <div class="flex-auto">
+            <Label for="alphanumeric" class="font-bold! block mb-2 "> Alphanumeric </Label>
+            <InputText id="alphanumeric" v-model="alphanumeric" v-keyfilter.alphanum class="w-full" />
+        </div>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const integer = ref(null);
+const number = ref(null);
+const money = ref(null);
+const hex = ref(null);
+const alphabetic = ref(null);
+const alphanumeric = ref(null);
+<\/script>
+```
+
+## Regex
+
+In addition to the presets, a regular expression can be configured for customization.
+
+```vue
+<template>
+    <div class="flex flex-wrap gap-4">
+        <div class="flex-auto">
+            <label for="blockspace" class="text-sm font-bold block mb-2"> Block Space </label>
+            <InputText id="blockspace" v-model="blockSpaceValue" v-keyfilter="blockSpace" class="w-full" />
+        </div>
+        <div class="flex-auto">
+            <label for="block" class="text-sm font-bold block mb-2"> Block < > * ! </label>
+            <InputText id="block" v-model="blockCharsValue" v-keyfilter="blockChars" class="w-full" />
+        </div>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const blockSpaceValue = ref(null);
+const blockCharsValue = ref(null);
+const blockSpace = /^[^\s]+$/;
+const blockChars = /^[^<>*!]+$/;
+<\/script>
+```
+
+## Regex Word
+
+Validation against the whole input is available with the validateOnly option enabled so that the keys are allowed only when the resulting value matches the pattern.
+
+```vue
+<template>
+    <div class="flex justify-center">
+        <div>
+            <Label for="numkeys" class="font-bold! block mb-2">Block Numeric (allow "+" only once at start)</Label>
+            <InputText id="numkeys" v-model="text" v-keyfilter="blockNumeric" fluid />
+        </div>
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const text = ref(null);
+const blockNumeric = { pattern: /^[+]?(\\d{1,12})?$/, validateOnly: true };
+<\/script>
+```
+
+## Accessibility
+
+Refer to InputText for accessibility as KeyFilter is a built-in add-on of the InputText.
+
+## Key Filter API
+
+### Pass Through Options
+
+| Name |Type |Description |
+| --- | --- | --- |
+| root | KeyFilterDirectivePassThroughOptionType | Used to pass attributes to the root's DOM element. |
+| hooks | any | Used to manage all lifecycle hooks. |
+
+### Theming