TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
83 lines
4.0 KiB
Plaintext
83 lines
4.0 KiB
Plaintext
import { AriaTextFieldProps } from "@react-types/textfield";
|
|
import { HTMLAttributes, JSX, LabelHTMLAttributes, RefObject } from "react";
|
|
import { DOMAttributes, ValidationResult, RefObject as _RefObject1 } from "@react-types/shared";
|
|
/**
|
|
* A map of HTML element names and their interface types.
|
|
* For example `'a'` -> `HTMLAnchorElement`.
|
|
*/
|
|
type IntrinsicHTMLElements = {
|
|
[K in keyof IntrinsicHTMLAttributes]: IntrinsicHTMLAttributes[K] extends HTMLAttributes<infer T> ? T : never;
|
|
};
|
|
/**
|
|
* A map of HTML element names and their attribute interface types.
|
|
* For example `'a'` -> `AnchorHTMLAttributes<HTMLAnchorElement>`.
|
|
*/
|
|
type IntrinsicHTMLAttributes = JSX.IntrinsicElements;
|
|
type DefaultElementType = 'input';
|
|
/**
|
|
* The intrinsic HTML element names that `useTextField` supports; e.g. `input`,
|
|
* `textarea`.
|
|
*/
|
|
type TextFieldIntrinsicElements = keyof Pick<IntrinsicHTMLElements, 'input' | 'textarea'>;
|
|
/**
|
|
* The HTML element interfaces that `useTextField` supports based on what is
|
|
* defined for `TextFieldIntrinsicElements`; e.g. `HTMLInputElement`,
|
|
* `HTMLTextAreaElement`.
|
|
*/
|
|
type TextFieldHTMLElementType = Pick<IntrinsicHTMLElements, TextFieldIntrinsicElements>;
|
|
/**
|
|
* The HTML attributes interfaces that `useTextField` supports based on what
|
|
* is defined for `TextFieldIntrinsicElements`; e.g. `InputHTMLAttributes`,
|
|
* `TextareaHTMLAttributes`.
|
|
*/
|
|
type TextFieldHTMLAttributesType = Pick<IntrinsicHTMLAttributes, TextFieldIntrinsicElements>;
|
|
/**
|
|
* The type of `inputProps` returned by `useTextField`; e.g. `InputHTMLAttributes`,
|
|
* `TextareaHTMLAttributes`.
|
|
*/
|
|
type TextFieldInputProps<T extends TextFieldIntrinsicElements> = TextFieldHTMLAttributesType[T];
|
|
export interface AriaTextFieldOptions<T extends TextFieldIntrinsicElements> extends AriaTextFieldProps<TextFieldHTMLElementType[T]> {
|
|
/**
|
|
* The HTML element used to render the input, e.g. 'input', or 'textarea'.
|
|
* It determines whether certain HTML attributes will be included in `inputProps`.
|
|
* For example, [`type`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-type).
|
|
* @default 'input'
|
|
*/
|
|
inputElementType?: T;
|
|
/**
|
|
* Controls whether inputted text is automatically capitalized and, if so, in what manner.
|
|
* See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize).
|
|
*/
|
|
autoCapitalize?: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
|
|
}
|
|
/**
|
|
* The type of `ref` object that can be passed to `useTextField` based on the given
|
|
* intrinsic HTML element name; e.g.`RefObject<HTMLInputElement>`,
|
|
* `RefObject<HTMLTextAreaElement>`.
|
|
*/
|
|
type TextFieldRefObject<T extends TextFieldIntrinsicElements> = RefObject<TextFieldHTMLElementType[T] | null>;
|
|
export interface TextFieldAria<T extends TextFieldIntrinsicElements = DefaultElementType> extends ValidationResult {
|
|
/** Props for the input element. */
|
|
inputProps: TextFieldInputProps<T>;
|
|
/** Props for the text field's visible label element, if any. */
|
|
labelProps: DOMAttributes | LabelHTMLAttributes<HTMLLabelElement>;
|
|
/** Props for the text field's description element, if any. */
|
|
descriptionProps: DOMAttributes;
|
|
/** Props for the text field's error message element, if any. */
|
|
errorMessageProps: DOMAttributes;
|
|
}
|
|
/**
|
|
* Provides the behavior and accessibility implementation for a text field.
|
|
* @param props - Props for the text field.
|
|
* @param ref - Ref to the HTML input or textarea element.
|
|
*/
|
|
export function useTextField<T extends TextFieldIntrinsicElements = DefaultElementType>(props: AriaTextFieldOptions<T>, ref: TextFieldRefObject<T>): TextFieldAria<T>;
|
|
interface FormattedTextFieldState {
|
|
validate: (val: string) => boolean;
|
|
setInputValue: (val: string) => void;
|
|
}
|
|
export function useFormattedTextField(props: AriaTextFieldProps, state: FormattedTextFieldState, inputRef: _RefObject1<HTMLInputElement | null>): TextFieldAria;
|
|
export type { AriaTextFieldProps } from '@react-types/textfield';
|
|
|
|
//# sourceMappingURL=types.d.ts.map
|