UNPKG

766 BTypeScriptView Raw
1import { PaletteColorOptions, SimplePaletteColorOptions } from '../styles/createPalette';
2type AdditionalPropertiesToCheck = (keyof Omit<SimplePaletteColorOptions, 'main'>)[];
3/**
4 * Creates a filter function used to filter simple palette color options.
5 * The minimum requirement is that the object has a "main" property of type string, this is always checked.
6 * Optionally, you can pass additional properties to check.
7 *
8 * @param additionalPropertiesToCheck - Array containing "light", "dark", and/or "contrastText"
9 * @returns ([, value]: [any, PaletteColorOptions]) => boolean
10 */
11export default function createSimplePaletteValueFilter(additionalPropertiesToCheck?: AdditionalPropertiesToCheck): ([, value]: [any, PaletteColorOptions]) => boolean;
12export {};