@fayegram-ai/faye-ui/controls/text-field
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { TextField } from '@fayegram-ai/faye-ui/controls/text-field';Usage and behavior guide · API JSON
This entry declares a client boundary. Follow the rendering guide for framework integration.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
TextField | value | ({ label, description, error, id, containerClassName, startAdornment, endAdornment, ...props }: TextFieldProps) => import("react").JSX.Element |
TextFieldProps | type | TextFieldProps |
TextField
Convenience composition with native label/description semantics; Field remains available for advanced validation.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: InputState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
containerClassName | No | string | undefined | See the usage contract and declaration. |
defaultValue | No | string | number | readonly string[] | undefined | The default value of the input. Use when uncontrolled. |
description | No | ReactNode | See the usage contract and declaration. |
endAdornment | No | ReactNode | See the usage contract and declaration. |
error | No | ReactNode | See the usage contract and declaration. |
htmlSize | No | number | undefined | See the usage contract and declaration. |
invalid | No | boolean | undefined | See the usage contract and declaration. |
label | Yes | ReactNode | See the usage contract and declaration. |
onValueChange | No | ((value: string, eventDetails: Input.ChangeEventDetails) => void) | undefined | Callback fired when the value changes. Use when controlled. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, InputState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
size | No | VisualVariant<"input", "size"> | undefined | See the usage contract and declaration. |
startAdornment | No | ReactNode | See the usage contract and declaration. |
style | No | CSSProperties | ((state: InputState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
value | No | string | number | readonly string[] | undefined | The value of the input. Use when controlled. |
variant | No | VisualVariant<"input", "variant"> | undefined | See the usage contract and declaration. |
Defaults and customization
Defaults and native behavior are documented in the linked family guide. This reference does not infer a default from an optional property.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/controls/text-field.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.