@workday/canvas-kit-preview-react
Version:
Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.
38 lines • 1.75 kB
TypeScript
import * as React from 'react';
import { ErrorType, Themeable } from '@workday/canvas-kit-react/common';
/**
* @deprecated ⚠️ `SelectOptionProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead.
*/
export interface SelectOptionProps extends Themeable, React.LiHTMLAttributes<HTMLLIElement> {
/**
* The type of error associated with the SelectOption (if applicable).
*/
error?: ErrorType;
/**
* If true, set the SelectOption to the focused state.
* @default false
*/
focused?: boolean;
/**
* The HTML `id` of the SelectOption.
*/
id?: string;
/**
* If true, set the SelectOption to the interactive state. Non-interactive SelectOptions should not give any visual cues that they are interactive (e.g., remove hover styling).
* @default true
*/
interactive?: boolean;
/**
* The ref to the list item that the styled component renders. Use this to imperatively manipulate the SelectOption (e.g., to scroll to it if it's out of view in the Select menu).
*/
optionRef?: React.Ref<HTMLLIElement>;
/**
* The value of the SelectOption.
*/
value?: string;
}
/**
* @deprecated ⚠️ `SelectOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead.
*/
export declare const SelectOption: ({ children, focused, interactive, optionRef, value, ...elemProps }: SelectOptionProps) => React.JSX.Element;
//# sourceMappingURL=SelectOption.d.ts.map