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
118 lines
4.0 KiB
Plaintext
118 lines
4.0 KiB
Plaintext
/*
|
|
* Copyright 2020 Adobe. All rights reserved.
|
|
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License. You may obtain a copy
|
|
* of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software distributed under
|
|
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
* governing permissions and limitations under the License.
|
|
*/
|
|
|
|
import {ReactNode} from 'react';
|
|
|
|
export type ValidationState = 'valid' | 'invalid';
|
|
|
|
export type ValidationError = string | string[];
|
|
export type ValidationErrors = Record<string, ValidationError>;
|
|
export type ValidationFunction<T> = (value: T) => ValidationError | true | null | undefined;
|
|
|
|
export interface Validation<T = unknown> {
|
|
/** Whether user input is required on the input before form submission. */
|
|
isRequired?: boolean,
|
|
/** Whether the input value is invalid. */
|
|
isInvalid?: boolean,
|
|
/** @deprecated Use `isInvalid` instead. */
|
|
validationState?: ValidationState,
|
|
/**
|
|
* Whether to use native HTML form validation to prevent form submission
|
|
* when the value is missing or invalid, or mark the field as required
|
|
* or invalid via ARIA.
|
|
* @default 'aria'
|
|
*/
|
|
validationBehavior?: 'aria' | 'native',
|
|
/**
|
|
* A function that returns an error message if a given value is invalid.
|
|
* Validation errors are displayed to the user when the form is submitted
|
|
* if `validationBehavior="native"`. For realtime validation, use the `isInvalid`
|
|
* prop instead.
|
|
*/
|
|
validate?: (value: T) => ValidationError | true | null | undefined
|
|
}
|
|
|
|
export interface ValidationResult {
|
|
/** Whether the input value is invalid. */
|
|
isInvalid: boolean,
|
|
/** The current error messages for the input if it is invalid, otherwise an empty array. */
|
|
validationErrors: string[],
|
|
/** The native validation details for the input. */
|
|
validationDetails: ValidityState
|
|
}
|
|
|
|
export interface SpectrumFieldValidation<T> extends Omit<Validation<T>, 'isInvalid' | 'validationState'> {
|
|
/** Whether the input should display its "valid" or "invalid" visual styling. */
|
|
validationState?: ValidationState
|
|
}
|
|
|
|
export interface InputBase {
|
|
/** Whether the input is disabled. */
|
|
isDisabled?: boolean,
|
|
/** Whether the input can be selected but not changed by the user. */
|
|
isReadOnly?: boolean
|
|
}
|
|
|
|
export interface ValueBase<T, C = T> {
|
|
/** The current value (controlled). */
|
|
value?: T,
|
|
/** The default value (uncontrolled). */
|
|
defaultValue?: T,
|
|
/** Handler that is called when the value changes. */
|
|
onChange?: (value: C) => void
|
|
}
|
|
|
|
export interface TextInputBase {
|
|
/** Temporary text that occupies the text input when it is empty. */
|
|
placeholder?: string
|
|
}
|
|
|
|
export interface SpectrumTextInputBase {
|
|
/**
|
|
* Temporary text that occupies the text input when it is empty.
|
|
* Please use help text instead.
|
|
* @deprecated
|
|
**/
|
|
placeholder?: string
|
|
}
|
|
|
|
export interface RangeValue<T> {
|
|
/** The start value of the range. */
|
|
start: T,
|
|
/** The end value of the range. */
|
|
end: T
|
|
}
|
|
|
|
export interface RangeInputBase<T> {
|
|
/** The smallest value allowed for the input. */
|
|
minValue?: T,
|
|
/** The largest value allowed for the input. */
|
|
maxValue?: T,
|
|
/** The amount that the input value changes with each increment or decrement "tick". */
|
|
step?: T // ??
|
|
}
|
|
|
|
export interface HelpTextProps {
|
|
/** A description for the field. Provides a hint such as specific requirements for what to choose. */
|
|
description?: ReactNode,
|
|
/** An error message for the field. */
|
|
errorMessage?: ReactNode | ((v: ValidationResult) => ReactNode)
|
|
}
|
|
|
|
// Spectrum specific types. Extends `Validation` so that the `validationState` prop is available.
|
|
export interface SpectrumHelpTextProps extends HelpTextProps {
|
|
/** Whether the description is displayed with lighter text. */
|
|
isDisabled?: boolean,
|
|
/** Whether an error icon is rendered. */
|
|
showErrorIcon?: boolean
|
|
}
|