Options
All
  • Public
  • Public/Protected
  • All
Menu

Module contracts/Config

Index

Type aliases

BorderWidthUnit: "rem" | "em" | "px"
Config: { borderWidthUnit: BorderWidthUnit; camelizeTokenNames: boolean; debugMode: boolean; figmaData: string; figmagicFolder: string; fontUnit: FontUnits; letterSpacingUnit: LetterSpacingUnit; lineHeightUnit: LineHeightUnit; opacitiesUnit: OpacitiesUnit; outputDataTypeToken: OutputDataTypeToken; outputFolderElements: string; outputFolderGraphics: string; outputFolderTokens: string; outputFormatColors: OutputFormatColors; outputFormatCss: OutputFormatCss; outputFormatDescription: OutputFormatDescription; outputFormatElements: OutputFormatElements; outputFormatGraphics: OutputFormatGraphics; outputFormatStorybook: OutputFormatStorybook; outputFormatTokens: OutputFormatTokens; outputGraphicElements: boolean; outputGraphicElementsMap: boolean; outputScaleGraphics: number; overwrite: Overwrite; radiusUnit: RadiusUnit; recompileLocal: boolean; remSize: number; shadowUnit: ShadowUnit; skipFileGeneration: { forceUpdate: boolean; skipCss: boolean; skipDescription: boolean; skipReact: boolean; skipStorybook: boolean; skipStyled: boolean }; spacingUnit: SpacingUnit; syncElements: boolean; syncGraphics: boolean; syncTokens: boolean; templates: { templatePathGraphic: string; templatePathReact: string; templatePathStorybook: string; templatePathStyled: string }; token: string | null; tokensRelativeImportPrefix: string; unitlessPrecision: number; url: string | null; usePostscriptFontNames: boolean; versionName: string | null }

Type declaration

  • borderWidthUnit: BorderWidthUnit
  • camelizeTokenNames: boolean
  • debugMode: boolean
  • figmaData: string
  • figmagicFolder: string
  • fontUnit: FontUnits
  • letterSpacingUnit: LetterSpacingUnit
  • lineHeightUnit: LineHeightUnit
  • opacitiesUnit: OpacitiesUnit
  • outputDataTypeToken: OutputDataTypeToken
  • outputFolderElements: string
  • outputFolderGraphics: string
  • outputFolderTokens: string
  • outputFormatColors: OutputFormatColors
  • outputFormatCss: OutputFormatCss
  • outputFormatDescription: OutputFormatDescription
  • outputFormatElements: OutputFormatElements
  • outputFormatGraphics: OutputFormatGraphics
  • outputFormatStorybook: OutputFormatStorybook
  • outputFormatTokens: OutputFormatTokens
  • outputGraphicElements: boolean
  • outputGraphicElementsMap: boolean
  • outputScaleGraphics: number
  • overwrite: Overwrite
  • radiusUnit: RadiusUnit
  • recompileLocal: boolean
  • remSize: number
  • shadowUnit: ShadowUnit
  • skipFileGeneration: { forceUpdate: boolean; skipCss: boolean; skipDescription: boolean; skipReact: boolean; skipStorybook: boolean; skipStyled: boolean }
    • forceUpdate: boolean
    • skipCss: boolean
    • skipDescription: boolean
    • skipReact: boolean
    • skipStorybook: boolean
    • skipStyled: boolean
  • spacingUnit: SpacingUnit
  • syncElements: boolean
  • syncGraphics: boolean
  • syncTokens: boolean
  • templates: { templatePathGraphic: string; templatePathReact: string; templatePathStorybook: string; templatePathStyled: string }
    • templatePathGraphic: string
    • templatePathReact: string
    • templatePathStorybook: string
    • templatePathStyled: string
  • token: string | null
  • tokensRelativeImportPrefix: string
  • unitlessPrecision: number
  • url: string | null
  • usePostscriptFontNames: boolean
  • versionName: string | null
ConfigDTO: { borderWidthUnit?: BorderWidthUnit; camelizeTokenNames?: boolean; debugMode?: boolean; figmaData?: string; figmagicFolder?: string; fontUnit?: FontUnits; letterSpacingUnit?: LetterSpacingUnit; lineHeightUnit?: LineHeightUnit; opacitiesUnit?: OpacitiesUnit; outputDataTypeToken?: OutputDataTypeToken; outputFolderElements?: string; outputFolderGraphics?: string; outputFolderTokens?: string; outputFormatColors?: OutputFormatColors; outputFormatCss?: OutputFormatCss; outputFormatDescription?: OutputFormatDescription; outputFormatElements?: OutputFormatElements; outputFormatGraphics?: OutputFormatGraphics; outputFormatStorybook?: OutputFormatStorybook; outputFormatTokens?: OutputFormatTokens; outputGraphicElements?: boolean; outputGraphicElementsMap?: boolean; outputScaleGraphics?: number; overwrite?: { css: boolean; description: boolean; graphic: boolean; react: boolean; storybook: boolean; styled: boolean }; radiusUnit?: RadiusUnit; recompileLocal?: boolean; remSize?: number; shadowUnit?: ShadowUnit; skipFileGeneration?: { forceUpdate?: boolean; skipCss?: boolean; skipDescription?: boolean; skipReact?: boolean; skipStorybook?: boolean; skipStyled?: boolean }; spacingUnit?: SpacingUnit; syncElements?: boolean; syncGraphics?: boolean; syncTokens?: boolean; templates?: { templatePathGraphic?: string; templatePathReact?: string; templatePathStorybook?: string; templatePathStyled?: string }; token?: string | null; tokensRelativeImportPrefix?: string | null; unitlessPrecision?: number; url?: string | null; usePostscriptFontNames?: boolean; versionName?: string | null }

Type declaration

  • Optional borderWidthUnit?: BorderWidthUnit
  • Optional camelizeTokenNames?: boolean
  • Optional debugMode?: boolean
  • Optional figmaData?: string
  • Optional figmagicFolder?: string
  • Optional fontUnit?: FontUnits
  • Optional letterSpacingUnit?: LetterSpacingUnit
  • Optional lineHeightUnit?: LineHeightUnit
  • Optional opacitiesUnit?: OpacitiesUnit
  • Optional outputDataTypeToken?: OutputDataTypeToken
  • Optional outputFolderElements?: string
  • Optional outputFolderGraphics?: string
  • Optional outputFolderTokens?: string
  • Optional outputFormatColors?: OutputFormatColors
  • Optional outputFormatCss?: OutputFormatCss
  • Optional outputFormatDescription?: OutputFormatDescription
  • Optional outputFormatElements?: OutputFormatElements
  • Optional outputFormatGraphics?: OutputFormatGraphics
  • Optional outputFormatStorybook?: OutputFormatStorybook
  • Optional outputFormatTokens?: OutputFormatTokens
  • Optional outputGraphicElements?: boolean
  • Optional outputGraphicElementsMap?: boolean
  • Optional outputScaleGraphics?: number
  • Optional overwrite?: { css: boolean; description: boolean; graphic: boolean; react: boolean; storybook: boolean; styled: boolean }
    • css: boolean
    • description: boolean
    • graphic: boolean
    • react: boolean
    • storybook: boolean
    • styled: boolean
  • Optional radiusUnit?: RadiusUnit
  • Optional recompileLocal?: boolean
  • Optional remSize?: number
  • Optional shadowUnit?: ShadowUnit
  • Optional skipFileGeneration?: { forceUpdate?: boolean; skipCss?: boolean; skipDescription?: boolean; skipReact?: boolean; skipStorybook?: boolean; skipStyled?: boolean }
    • Optional forceUpdate?: boolean
    • Optional skipCss?: boolean
    • Optional skipDescription?: boolean
    • Optional skipReact?: boolean
    • Optional skipStorybook?: boolean
    • Optional skipStyled?: boolean
  • Optional spacingUnit?: SpacingUnit
  • Optional syncElements?: boolean
  • Optional syncGraphics?: boolean
  • Optional syncTokens?: boolean
  • Optional templates?: { templatePathGraphic?: string; templatePathReact?: string; templatePathStorybook?: string; templatePathStyled?: string }
    • Optional templatePathGraphic?: string
    • Optional templatePathReact?: string
    • Optional templatePathStorybook?: string
    • Optional templatePathStyled?: string
  • Optional token?: string | null
  • Optional tokensRelativeImportPrefix?: string | null
  • Optional unitlessPrecision?: number
  • Optional url?: string | null
  • Optional usePostscriptFontNames?: boolean
  • Optional versionName?: string | null
FontUnits: "rem" | "em" | "px"
LetterSpacingUnit: "em" | "px"
LineHeightUnit: "unitless" | "px" | "rem" | "em"
OpacitiesUnit: "float" | "percent"
OutputDataTypeToken: null | "enum"
OutputFormatColors: "hex" | "rgba"
OutputFormatCss: "ts" | "mjs" | "js"
OutputFormatDescription: "md" | "txt"
OutputFormatElements: "tsx" | "jsx"
OutputFormatGraphics: "svg" | "png"
OutputFormatStorybook: "ts" | "js" | "mdx"
OutputFormatTokens: "ts" | "mjs" | "js" | "json"
Overwrite: { css: boolean; description: boolean; graphic: boolean; react: boolean; storybook: boolean; styled: boolean }

Type declaration

  • css: boolean
  • description: boolean
  • graphic: boolean
  • react: boolean
  • storybook: boolean
  • styled: boolean
RadiusUnit: "rem" | "em" | "px"
ShadowUnit: "rem" | "em" | "px"
SpacingUnit: "rem" | "em" | "px"

Generated using TypeDoc