UNPKG

@fluentui/react/lib-commonjs/utilities/color/getColorFromString.d.ts

Version:

476 BTypeScriptView Raw

1import type { IColor } from './interfaces';
2/**
* Converts a CSS color string to a color object.
* Note that hex colors *must* be prefixed with # to be considered valid.
*
* `inputColor` will be used unmodified as the `str` property of the returned object.
* Alpha defaults to 100 if not specified in `inputColor`.
* Returns undefined if the color string is invalid/not recognized.
*/
10export declare function getColorFromString(inputColor: string): IColor | undefined;

1	`import type { IColor } from './interfaces';`
2	`/**`
3	`* Converts a CSS color string to a color object.`
4	`* Note that hex colors must be prefixed with # to be considered valid.`
5	`*`
6	* `inputColor` will be used unmodified as the `str` property of the returned object.
7	* Alpha defaults to 100 if not specified in `inputColor`.
8	`* Returns undefined if the color string is invalid/not recognized.`
9	`*/`
10	`export declare function getColorFromString(inputColor: string): IColor \| undefined;`