@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
40 lines • 1.78 kB
TypeScript
import { Theme, CSSObject } from '@emotion/react';
interface FocusRingOptions {
width?: number;
separation?: number;
animate?: boolean;
/**
* Specifies where the ring(s) should be attached.
* - undefined: Both "inner" and "outer" shadows outside the container.
* - 'inner': "Inner" shadow inset. "Outer" shadow outside the container.
* - 'outer': Both "inner" and "outer" shadows inside the container.
*/
inset?: 'inner' | 'outer';
innerColor?: string;
outerColor?: string;
}
/**
* A utility to create a canvas style focus ring around your widget.
* By default, this mixin will create a 2px focus ring tightly wrapped
* to the container (no whitespace).
*
* @param width Allows the user to specify the thickness in px of the focus ring.
* @param separation Allows the user to define the width in px of the whitespace
* that there should be between the component and the focus ring.
* @param animate Set property to false to opt out of the standard grow out of the middle animation
* @param inset Determines whether or not the focus ring is inset
* @param innerShadowColor Allows the user to specify the inner shadow color
* @param outerShadowColor Allows the user to specify the outer shadow color
*
* @returns {CSSObject} the css object for the focus ring style
*/
/**
* A utility to create a canvas style focus ring around your widget.
* By default, this mixin will create a 2px focus ring tightly wrapped
* to the container (no whitespace).
*
* @returns {CSSObject} the css object for the focus ring style
*/
export declare function focusRing(options?: FocusRingOptions, theme?: Theme): CSSObject;
export {};
//# sourceMappingURL=focusRing.d.ts.map