javascript - Hur skriver man en färgegenskap?

Min komponent accepterar en overlay-prop som ska vara en giltig CSS-färg.

När jag CTRL + Klickar på en color-egenskap i ett stilobjekt, kommer typdefinitionen från en csstype-mapp inne i node_modules. Typdefinitionen för CSS-färg-egenskapen definieras som Property.Color. Jag importerade den typen till min komponent och använde den som typen för min overlay-prop, men den blir any när jag försöker använda den komponenten.

Min komponents typdefinition:

import { Property } from "../node_modules/csstype/index";


export interface BlurredComponentProps {
  overlay?: Property.Color;
}

Så här ser det ut när jag använder komponenten:

Så min fråga är, hur man korrekt anger en prop som bara ska ta giltiga CSS-färger och ge fel om ett icke-färgvärde anges?

Tack

Svar #1

Den här är ganska svår att koda i TypeScripts typesystem. Jag tror att en fullfjädrad parser kan göra ett bättre jobb både i hastighet och noggrannhet.

Hur som helst, om du verkligen vill få någon typkontroll för dina color-värden från TypeScript, låt oss då börja med w3c:s beskrivning av färgegenskapen:

Values: <color value> | <color keyword> | currentColor | transparent | inherit

lekplatslänk för dem som inte behöver förklaringar och vad man ska titta direkt i koden.

Tja, color keyword, currentColor, transparent och inherit är ganska enkla:

type Color = ColorValue | ColorKeyword | 'currentColor' | 'transparent' | 'inherit'

type ColorKeyword =
    | "black"
    | "silver"
    | "gray"
    ...
    | "rebeccapurple"

Den knepiga delen är <color value>:

The color can be specified as

* a hexadecimal RGB value: #faf or #ffaaff
* a RGB value: rgb(255, 160, 255) or rgb(100%, 62.5%, 100%)
      Each value is from 0 to 255, or from 0% to 100%.
* a RGBA value: rgba(255, 160, 255, 1) or rgba(100%, 62.5%, 100%, 1)
      This variant includes an “alpha” component to allow 
      specification of the opacity of a color. Values are 
      in the range 0.0 (fully transparent) to 1.0 (fully opaque).
* a HSL value: hsl(0, 100%, 50%)
      A triple (hue, saturation, lightness). hue is an 
      angle in degrees. saturation and lightness are 
      percentages (0-100%).
* a HSLA value: hsla(0, 100%, 50%, 1)
      This variant includes an “alpha” component to allow 
      specification of the opacity of a color. Values are 
      in the range 0.0 (fully transparent) to 1.0 (fully opaque).

hexadecimal RGB-värde är fortfarande hyfsat okej:

type HexDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f'

type Hex3 = `${HexDigit}${HexDigit}${HexDigit}`

type RGBColor<T extends string> = 
  Lowercase<T> extends `#${Hex3}`
      ? T
      : Lowercase<T> extends `#${Hex3}${infer Rest}`
        ? Rest extends Hex3
            ? T
            : never
        : never

Vi måste introducera typvariabeln T. Annars 'platt' unionstyp:

type RGBColor = `#${Hex3}` | `#${Hex3}${Hex3}`

kommer att bestå av 16^3 + 16^6 komponenter, vilket är långt bortom 100000 typescript-gränsen för unionstyper.

Låt oss introducera några hjälptyper för att arbeta med siffror. Vi måste kontrollera att procenten inte är större än 100% och slutar med tecknet %.

type DecDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
type Digits0to4 = '0' | '1' | '2' | '3' | '4'

type OnlyDecDigits<T extends string> = 
    T extends `${DecDigit}${infer Rest}`
        ? Rest extends ''
            ? 1
            : OnlyDecDigits<Rest>
        : never

type IsDecNumber<T extends string> =
    T extends `${infer Integer}.${infer Fractional}`
        ? Integer extends ''
            ? OnlyDecDigits<Fractional>
            : Fractional extends ''
                ? OnlyDecDigits<Integer>
                : OnlyDecDigits<Integer> & OnlyDecDigits<Fractional>
        : OnlyDecDigits<T>

type IntegerPart<T extends string> =
    T extends `${infer I}.${infer F}`
        ? I
        : T

type IsInteger<T extends string> = 
    1 extends IsDecNumber<T>
        ? T extends IntegerPart<T> 
            ? 1 
            : never
        : never

type Less100<T extends string> = 
    IsDecNumber<T> extends 1
        ? IntegerPart<T> extends `${DecDigit}` | `${DecDigit}${DecDigit}` | '100'
            ? 1
            : never
        : never

type IsPercent<T extends string> =
    '0' extends T
        ? 1
        : T extends `${infer P}%` 
            ? Less100<P> 
            : never

Färgvärden måste också vara heltal och får inte vara större än 255:

type Color255<T extends string> =
    1 extends IsInteger<T>
        ? T extends `${DecDigit}` 
                  | `${DecDigit}${DecDigit}` 
                  | `1${DecDigit}${DecDigit}` 
                  | `2${Digits0to4}${DecDigit}`
                  | `25${Digits0to4 | '5'}`
            ? 1
            : never
        : never

så, vilket färgvärde som helst kan kodas som ett heltal i [0..255]-intervallet eller en procent:

type IsColorValue<T extends string> = IsPercent<T> | Color255<T>

Lägger till verktygstypen Trim för att ta bort extra mellanslag i båda ändar:

type WhiteSpace = ' '
type Trim<T> = T extends `${WhiteSpace}${infer U}` 
    ? Trim<U> 
    : T extends `${infer U}${WhiteSpace}` 
        ? Trim<U> 
        : T;

Det räcker för rgb:

type RGB<T extends string> = 
    T extends `rgb(${infer R},${infer G},${infer B})` 
        ? '111' extends `${IsColorValue<Trim<R>>}${IsColorValue<Trim<G>>}${IsColorValue<Trim<B>>}`
            ? T
            : never
        : never

För rgba/hsla behöver vi opacitet. Här frågar vi bara efter ett giltigt nummer eller en procent:

type Opacity<T extends string> = IsDecNumber<T> | IsPercent<T>

Nu kan vi kontrollera rgba-värden:

type RGBA<T extends string> =
    T extends `rgba(${infer R},${infer G},${infer B},${infer O})`
        ? '1111' extends `${IsColorValue<Trim<R>>}${IsColorValue<Trim<G>>}${IsColorValue<Trim<B>>}${Opacity<Trim<O>>}`
            ? T
            : never
        : never

Lägger till gradkontroll för hsl/hsla:

type Degree<T extends string> =
    1 extends IsInteger<T>
        ? T extends `${DecDigit}`
                  | `${DecDigit}${DecDigit}`
                  | `${'1' | '2'}${DecDigit}${DecDigit}`
                  | `3${Digits0to4 | '5'}${DecDigit}`
                  | '360'
            ? 1
            : never
        : never

och slutligen kan vi ta upp de sista fallen:

type HSL<T extends string> =
    T extends `hsl(${infer H},${infer S},${infer L})`
        ? `111` extends `${Degree<Trim<H>>}${IsPercent<Trim<S>>}${IsPercent<Trim<L>>}`
            ? T
            : never
        :never

type HSLA<T extends string> =
    T extends `hsla(${infer H},${infer S},${infer L},${infer O})`
        ? `1111` extends `${Degree<Trim<H>>}${IsPercent<Trim<S>>}${IsPercent<Trim<L>>}${Opacity<Trim<O>>}`
            ? T
            : never
        :never

Så vår slutliga typ kommer att se ut så här:

type ColorValue<T extends string> = HexColor<T> | RGB<T> | RGBA<T> | HSL<T> | HSLA<T>

type Color<T extends string> = ColorValue<T> | ColorKeyword | 'currentColor' | 'transparent' | 'inherit'

lekplatslänk

Relaterade artiklar