Skip to content
API References
ShortTailwindest

ShortTailwindest

Briefly

  1. Use to create a type with a custom value defined in tailwind.config.js.
  2. Use to pick the tailwind property type for typing.
  3. Support shorthanded syntax like backgroundColor to bg.
💡

ShortTailwindest api is same as Tailwindest, but with shorthanded syntax.

Check out the Tailwindest page for detailed api information.

Type definition

Default breakIdentifier is $ for convenience.

type ShortTailwindest<
    TailwindGlobal extends
        TailwindGlobalPlugOption = TailwindDefaultGlobalPlugOption,
    TailwindStyle extends TailwindStylePlugOption = TailwindDefaultStylePlug,
    TailwindNestConditionPrefix extends
        TailwindNestConditionIdentifierOption = {
        breakIdentifier: "$"
        pseudoClassIdentifier: "$"
        pseudoElementIdentifier: "$"
    },
> = ShortTailwindestTypeSet<
    TailwindestNestKeys<
        TailwindNestConditionPrefix,
        { screens: TailwindGlobal["screens"]; aria: TailwindStyle["aria"] }
    >,
    ShortTailwindPlugin<TailwindGlobal, TailwindStyle>,
    | TailwindNestConditionPrefix["breakIdentifier"]
    | TailwindNestConditionPrefix["pseudoClassIdentifier"]
    | TailwindNestConditionPrefix["pseudoElementIdentifier"]
>