UNPKG

2.47 kBTypeScriptView Raw
1import { IRawStyle } from '@uifabric/merge-styles';
2import { IGetFocusStylesOptions, ITheme } from '../interfaces/index';
3/**
4 * Generates a focus style which can be used to define an :after focus border.
5 *
6 * @param theme - The theme object to use.
7 * @param options - Options to customize the focus border.
8 * @returns The style object.
9 */
10export declare function getFocusStyle(theme: ITheme, options?: IGetFocusStylesOptions): IRawStyle;
11/**
12 * Generates a focus style which can be used to define an :after focus border.
13 *
14 * @param theme - The theme object to use.
15 * @param inset - The number of pixels to inset the border.
16 * @param position - The positioning applied to the container. Must
17 * be 'relative' or 'absolute' so that the focus border can live around it.
18 * @param highContrastStyle - Style for high contrast mode.
19 * @param borderColor - Color of the border.
20 * @param outlineColor - Color of the outline.
21 * @param isFocusedOnly - If the styles should apply on focus or not.
22 * @returns The style object.
23 * @deprecated Use the object parameter version instead.
24 */
25export declare function getFocusStyle(theme: ITheme, inset?: number, position?: 'relative' | 'absolute', highContrastStyle?: IRawStyle | undefined, borderColor?: string, outlineColor?: string, isFocusedOnly?: boolean): IRawStyle;
26/**
27 * Generates style to clear browser specific focus styles.
28 */
29export declare function focusClear(): IRawStyle;
30/**
31 * Generates a style which can be used to set a border on focus.
32 *
33 * @param theme - The theme object to use.
34 * @param inset - The number of pixels to inset the border (default 0)
35 * @param width - The border width in pixels (default 1)
36 * @param color - Color of the outline (default `theme.palette.neutralSecondary`)
37 * @returns The style object.
38 */
39export declare function getFocusOutlineStyle(theme: ITheme, inset?: number, width?: number, color?: string): IRawStyle;
40/**
41 * Generates text input border styles on focus.
42 *
43 * @param borderColor - Color of the border.
44 * @param borderRadius - Radius of the border.
45 * @param borderType - Type of the border.
46 * @param borderPosition - Position of the border relative to the input element (default to -1
47 * as it's the most common border width of the input element)
48 * @returns The style object.
49 */
50export declare const getInputFocusStyle: (borderColor: string, borderRadius: string | number, borderType?: "border" | "borderBottom", borderPosition?: number) => IRawStyle;