Type alias MetadataJSON

MetadataJSON: {
    author?: string;
    backcolor?: string;
    background?: BackgroundJSON;
    css?: string;
    name?: string;
    notes?: string;
    pcb?: boolean;
    plate?: boolean;
    radii?: string;
    switchBrand?: string;
    switchMount?: string;
    switchType?: string;
    [k: string]: unknown;
}

Metadata information.

Type declaration

  • [k: string]: unknown
  • Optional author?: string

    Author name.

  • Optional backcolor?: string

    Background CSS color.

  • Optional background?: BackgroundJSON
  • Optional css?: string

    CSS stylesheet.

  • Optional name?: string

    The Keyboard name.

  • Optional notes?: string

    Author's notes.

  • Optional pcb?: boolean

    Whether the switches are pcb mounted.

  • Optional plate?: boolean

    Whether the switches are plate mounted

  • Optional radii?: string

    CSS border radius value.

  • Optional switchBrand?: string

    Default switch brand for the keys.

  • Optional switchMount?: string

    Default switch mount for the keys.

  • Optional switchType?: string

    Default switch type for the keys.

Generated using TypeDoc