The official FormKit Inputs plugin. This package contains the source code for all native HTML input types. Read the inputs documentation for usage instructions.
Applies attributes to a given schema section by applying a higher order function that merges a given set of attributes into the node.
attrs
— Attributes to apply to a FormKitSchemaExtendableSection.section
— A section to apply attributes to.FormKitSchemaExtendableSection
Extends a schema node with a given set of extensions.
section
— A section to apply an extension to.extendWith
— A partial schema snippet to apply to the section.FormKitSchemaExtendableSection
Applies a condition to a given schema section.
varName
— The name of the variable that holds the current instance.inName
— The variable we are iterating over.section
— A section to repeat.FormKitSchemaExtendableSection
Applies a condition to a given schema section.
condition
— A schema condition to apply to a section.then
— The section that applies if the condition is true.otherwise
— (else) The section that applies if the condition is false.FormKitSchemaExtendableSection
Creates a root schema section.
section
— A section to make a root from.FormKitSchemaExtendableSection
A feature that adds checkbox selection support.
node
— A FormKitNode.Adds icon props definition.
sectionKey
— the location the icon should be loaded.defaultIcon
— the icon that should be loaded if a match is found in the user's CSS.A feature to add file handling support to an input.
node
— A FormKitNode.A feature that ensures the input has an initialValue
prop.
node
— A FormKitNode.Creates a new feature that generates a localization message of type ui for use on a given component.
key
— The key of the message.value
— The value of the message.A feature that normalizes box types (checkboxes, radios).
node
— A FormKitNode.A feature that converts the options prop to usable values, to be used by a feature or a plugin.
node
— A FormKitNode.A feature to check if the value being checked is the current value.
node
— A FormKitNode.key
— A new section key name.schema
— The default schema in this composable slot.Creates a plugin based on a list of FormKitLibrary.
libraries
— One or many FormKitLibrary.Creates a new reusable section.
section
— A single section of schemael
— The element or a function that returns a schema node.root
— When true, returns a FormKitExtendableSchemaRoot. When false, returns a FormKitSchemaExtendableSection.Returns a FormKitExtendableSchemaRoot or a FormKitSchemaExtendableSection.
A feature that allows disabling children of this node.
node
— A FormKitNode.Extends a single schema node with an extension. The extension can be any partial node including strings.
schema
— The base schema node.extension
— The values to extend on the base schema node.A feature to add a submit handler and actions section.
node
— A FormKitNode.A feature that applies ignore="true"
by default.
node
— A FormKitNode.Type guard for schema objects.
schema
— returns true
if the node is a schema node but not a string or conditional.boolean
Checks if the current schema node is a slot condition.
node
— A FormKitSchemaNode.boolean
A function to normalize an array of objects, array of strings, or object of key-values to use an array of objects with value and label properties.
options
— An un-normalized FormKitOptionsProp.
A list of FormKitOptionsList.
Converts the options prop to usable values.
node
— A formkit node.Creates an input schema with all of the wrapping base schema.
inputSection
— Content to store in the input section key location.A single file object in FormKit’s synthetic "FileList".
Options should always be formatted as an array of objects with label and value properties.
Allows for prop extensions to be defined by using an interface whose keys are ignored, but values are applied to a union type. This allows for any third party code to extend the options prop by using module augmentation to add new values to the union type.
A function that is called with an extensions argument and returns a valid schema node.
A function that when called, returns a function that can in turn be called with an extension parameter.
Synthetic props are props that are not explicitly declared as props, but should be treated as props to the outside world.
A synthetic array-based "FileList".
Either a schema node, or a function that returns a schema node.
An array of option items.
The types of options that can be passed to the options prop.
The synthetic prop types.