Options
All
  • Public
  • Public/Protected
  • All
Menu

Package gatsby

Type aliases

ArrayPropertyProps

ArrayPropertyProps: DescribeProps

ArrayProps

ArrayProps: KeyProps & object

ComponentPropsWithoutTheme

ComponentPropsWithoutTheme<T>: Omit<React.ComponentProps<T>, "theme">

Type parameters

  • T: keyof IntrinsicElements | React.JSXElementConstructor<any>

DescribeProps

DescribeProps: ThemeProps & NestedSectionHeaderProps & object

DictionaryPropertyProps

DictionaryPropertyProps: DescribeProps & DictionaryProps

DictionaryProps

DictionaryProps: KeyProps & object

KeyProps

LogoProps

LogoProps: object

Type declaration

  • align: string
  • Optional height?: number | string

NestedSectionHeaderProps

NestedSectionHeaderProps: object

Type declaration

  • Optional name?: undefined | string

Query

Query: object

Type declaration

SEOProps

SEOProps: object

Type declaration

  • Optional description?: undefined | string
  • Optional keywords?: Array<string>
  • Optional lang?: undefined | string
  • Optional meta?: Array<object>
  • title: string

ScalarPropertyProps

ScalarPropertyProps: DescribeProps & ScalarProps

ScalarProps

ScalarProps: KeyProps & object

SchemaState

SchemaState: object

Type declaration

  • mode: SchemaMode
  • pathSegments: Array<string>
  • renderAnchor: boolean

Site

Site: object

Type declaration

SiteMetadata

SiteMetadata: object

Type declaration

  • author: string
  • description: string
  • title: string

Theme

Theme: object

Type declaration

  • arrays: object
    • leading: string
    • prefix: string
    • suffix: string
    • trailing: string
  • colors: object
    • background: string
    • boolean: string
    • code: string
    • documentation: string
    • highlight: string
    • key: string
    • number: string
    • string: string
  • dictionaries: object
    • leading: string
    • suffix: string
    • trailing: string
  • formatKey: function
      • (value: unknown): string
      • Parameters

        • value: unknown

        Returns string

  • formatValue: function
      • (value: unknown): string
      • Parameters

        • value: unknown

        Returns string

  • keys: object
    • suffix: string

ThemeProps

ThemeProps: object

Type declaration

Variables

Const AnchorContainer

AnchorContainer: StyledComponent<ClassAttributes<HTMLAnchorElement> & AnchorHTMLAttributes<HTMLAnchorElement>, object, object> = styled.a`margin-left: -15px;padding: 15px;color: inherit;text-decoration: none;`

Const Container

Container: StyledComponent<ClassAttributes<HTMLElement> & HTMLAttributes<HTMLElement>, object, object> = styled.article<ThemeProps>`padding: 1.5em;font-family: "PT Mono", monospace;line-height: 1.6em;background: ${props => props.theme.colors.background};color: ${props => props.theme.colors.documentation};code {font-family: "PT Mono", monospace;color: ${props => props.theme.colors.code};}&, span {white-space: nowrap;}`

Const Description

Description: StyledComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, object, object> = styled.div`margin-bottom: 0.5em;font-family: "Open Sans", sans-serif;white-space: normal;`

Const DescriptionAnchor

DescriptionAnchor: StyledComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, object, object> = styled.div<ThemeProps>`margin-top: -3em;padding: 1.5em 0;p {margin-top: 0;}p:last-of-type {margin-bottom: 0;}&:target > div {background: ${props => props.theme.colors.highlight};}`

Const DescriptionContainer

DescriptionContainer: StyledComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, object, object> = styled.div`padding: 1em;&:first-of-type {margin-top: 0;}& + div {margin-top: -0.5em;}`

Const Main

Main: StyledComponent<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, object, object> = styled.div`border: 1px solid;padding: 1em;font-family: "Open Sans", sans-serif;white-space: normal;& + * {margin-top: 0 !important;}p {margin-top: 0;}p:last-of-type {margin-bottom: 0;}`

Const NestedSectionHeaderContext

NestedSectionHeaderContext: Context<number> = React.createContext(1)

Const SYNTAX_COMPONENTS

SYNTAX_COMPONENTS: object = {CONTAINERS: {JsonContainer, SymlContainer},MAINS: {JsonMain, SymlMain},SCALARS: {JsonScalar, SymlScalar},SCALAR_PROPERTIES: {JsonScalarProperty, SymlScalarProperty},OBJECT_PROPERTIES: {JsonObjectProperty, SymlObjectProperty},ARRAY_PROPERTIES: {JsonArrayProperty, SymlArrayProperty},} as const

Type declaration

  • ARRAY_PROPERTIES: object
    • JsonArrayProperty: JsonArrayProperty
    • SymlArrayProperty: SymlArrayProperty
  • CONTAINERS: object
    • JsonContainer: JsonContainer
    • SymlContainer: SymlContainer
  • MAINS: object
    • JsonMain: JsonMain
    • SymlMain: SymlMain
  • OBJECT_PROPERTIES: object
    • JsonObjectProperty: JsonObjectProperty
    • SymlObjectProperty: SymlObjectProperty
  • SCALARS: object
    • JsonScalar: JsonScalar
    • SymlScalar: SymlScalar
  • SCALAR_PROPERTIES: object
    • JsonScalarProperty: JsonScalarProperty
    • SymlScalarProperty: SymlScalarProperty

Const defaultKeywords

defaultKeywords: string[] = [`package manager`, `yarn`, `yarnpkg`, `configuration`, `yarnrc`]

Const marginContainer

marginContainer: SerializedStyles = css`& > :first-of-type {margin-top: -1.5em;}& > :last-of-type {margin-bottom: -1.5em;}&[data-dictionaries-suffix=""] > :last-child {margin-bottom: -2.5em;}`

Functions

Const Anchor

  • Anchor(): Element

Const Array

  • Array(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchorTarget: undefined | null | string
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • name: undefined | string
      • suffix: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const ArrayProperty

  • ArrayProperty(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchor: undefined | null | string
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • description: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • name: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const Describe

  • Describe(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchor: undefined | null | string
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • description: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • name: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const Dictionary

  • Dictionary(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchorTarget: undefined | null | string
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • margin: boolean
      • name: undefined | string
      • suffix: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const DictionaryProperty

  • DictionaryProperty(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchor: undefined | null | string
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • description: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • margin: boolean
      • name: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const JsonArrayProperty

Const JsonContainer

Const JsonMain

Const JsonObjectProperty

Const JsonScalar

Const JsonScalarProperty

Const Key

  • Key(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchorTarget: undefined | null | string
      • name: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const Logo

  • Logo(__namedParameters: object): Element

Const NestedSectionHeader

  • NestedSectionHeader(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • children: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • name: undefined | string

    Returns Element

SEO

  • SEO(__namedParameters: object): Element

Const Scalar

  • Scalar(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • placeholder: unknown
      • suffix: undefined | string
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const ScalarProperty

  • ScalarProperty(__namedParameters: object): Element
  • Parameters

    • __namedParameters: object
      • anchor: undefined | null | string
      • description: undefined | null | string | number | false | true | object | ReactElement<any, string | function | object> | ReactNodeArray | ReactPortal
      • name: undefined | string
      • placeholder: unknown
      • theme: object
        • arrays: object
          • leading: string
          • prefix: string
          • suffix: string
          • trailing: string
        • colors: object
          • background: string
          • boolean: string
          • code: string
          • documentation: string
          • highlight: string
          • key: string
          • number: string
          • string: string
        • dictionaries: object
          • leading: string
          • suffix: string
          • trailing: string
        • formatKey: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • formatValue: function
            • (value: unknown): string
            • Parameters

              • value: unknown

              Returns string

        • keys: object
          • suffix: string

    Returns Element

Const SymlArrayProperty

Const SymlContainer

Const SymlMain

Const SymlObjectProperty

Const SymlScalar

Const SymlScalarProperty

Const convertSchemaToConfiguration

  • convertSchemaToConfiguration(schema: JSONSchema7, __namedParameters: object): Element

Const getAnchor

Const getColorForScalar

  • getColorForScalar(theme: Theme, scalar: unknown): null | string

Const renderArrayProperty

Const renderDescription

  • renderDescription(name: string, definition: JSONSchema7): null | string | Element

Const renderMarkdown

  • renderMarkdown(markdown: string | undefined): null | Element

Const renderObjectProperty

  • renderObjectProperty(name: string, definition: JSONSchema7, __namedParameters: object): Element

Const renderProperty

  • renderProperty(name: string, definition: JSONSchema7Definition, state: SchemaState): Element

Const renderScalar

  • renderScalar(placeholder: JSONSchema7Type, state: SchemaState): Element

Const renderScalarProperty

Object literals

Const theme

theme: object

formatKey

  • formatKey(key: unknown): string

formatValue

  • formatValue(value: unknown): string

arrays

arrays: object

leading

leading: string = ``

prefix

prefix: string = `-\u00a0`

suffix

suffix: string = ``

trailing

trailing: string = ``

colors

colors: object

background

background: string = `#3f3f3f`

boolean

boolean: string = `#eddd3d`

code

code: string = `#639db1`

documentation

documentation: string = `#ddddcc`

highlight

highlight: string = `#716f6f`

key

key: string = `#dfc47d`

number

number: string = `#ffd700`

string

string: string = `#cc9393`

dictionaries

dictionaries: object

leading

leading: string = ``

suffix

suffix: string = ``

trailing

trailing: string = ``

keys

keys: object

suffix

suffix: string = `: `

Const theme

theme: object

formatKey

  • formatKey(key: unknown): string

formatValue

  • formatValue(value: unknown): string

arrays

arrays: object

leading

leading: string = `[`

prefix

prefix: string = ``

suffix

suffix: string = `,`

trailing

trailing: string = `]`

colors

colors: object

background

background: string = `#242424`

boolean

boolean: string = `#f08080`

code

code: string = `#639db1`

documentation

documentation: string = `#ddddcc`

highlight

highlight: string = `#384973`

key

key: string = `#8ac6f2`

number

number: string = `#ffd700`

string

string: string = `#95e454`

dictionaries

dictionaries: object

leading

leading: string = `{`

suffix

suffix: string = `,`

trailing

trailing: string = `}`

keys

keys: object

suffix

suffix: string = `: `

Generated using TypeDoc