The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
{/*
* _____ _
*|_ _|_ _____ _ __ | |_ _ _
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
* | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
* |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
* |___/
*
* This file is generated from the documentation data in packages/twenty-ui/generated.
* To update it, edit the component prop types or design tokens in twenty-ui and run:
* npx nx generate:ui twenty-docs
*/}
<ParamField body="className" type="string | ((state: InputState) => string | undefined)">
CSS class applied to the element, or a function that
returns a class based on the component's state.
</ParamField>
<ParamField body="defaultValue" type="string | number | readonly string[]">
The default value of the input. Use when uncontrolled.
</ParamField>
<ParamField body="hasFocusRing" type="boolean" default="true">
Set false to hide the focus border or outline while keeping errors visible. Defaults to true. InputGroup controls grouped focus styling.
</ParamField>
<ParamField body="onValueChange" type="((value: string, eventDetails: { reason: "none"; event: Event; cancel: () => void; allowPropagation: () => void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) => void)">
Receives the next string value and Base UI details, including the native event, reason and cancellation methods.
</ParamField>
<ParamField body="ref" type="Ref<HTMLInputElement>">
Ref to the native input element.
</ParamField>
<ParamField body="render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, InputState>">
Composes the native input with a custom element or render callback. Forward the supplied props and ref to an input.
</ParamField>
<ParamField body="size" type=""md" | "sm"">
Visual size. Explicit input size takes precedence over the InputGroup default, then md applies. Group layout still sets the surrounding height.
</ParamField>
<ParamField body="style" type="CSSProperties | ((state: InputState) => CSSProperties | undefined)">
Style applied to the element, or a function that
returns a style object based on the component's state.
</ParamField>
<ParamField body="textAlign" type=""end" | "start"">
Aligns text to the logical start or end of the input. Follows the text direction.
</ParamField>
<ParamField body="value" type="string | number | readonly string[]">
The value of the input. Use when controlled.
</ParamField>
<ParamField body="variant" type=""default" | "plain"" default="default">
default keeps the field frame. plain removes fill, border, radius and padding and uses natural height. Its outline follows native :focus-visible, including pointer focus or autofocus on text inputs; invalid state uses a danger outline. InputGroup always owns the grouped frame.
</ParamField>