gridstack-8.x-2.5/config/schema/gridstack.schema.yml

# Schema for the configuration files of the GridStack module.
gridstack.settings:
  type: config_object
  label: 'GridStack settings'
  mapping:
    framework:
      type: string
      label: 'Grid framework'
    fw_classes:
      type: string
      label: 'Framework classes'
    library:
      type: string
      label: 'Grid library'
    dev:
      type: boolean
      label: 'Use non-minified GridStack library'
    debug:
      type: boolean
      label: Debug
    optimized:
      type: boolean
      label: Optimized
    excludes:
      type: string
      label: 'Exclude optionsets'

gridstack_json:
  type: mapping
  label: JSON
  mapping:
    grids:
      type: sequence
      label: Grids
      sequence:
        - type: string
    settings:
      type: string
      label: Settings
    breakpoints:
      type: string
      label: Breakpoints

gridstack_breakpoint:
  type: mapping
  mapping:
    breakpoint:
      type: string
      label: Breakpoint
    column:
      type: integer
      label: Column
    image_style:
      type: string
      label: 'Image style'
    width:
      type: integer
      label: Width
    grids:
      type: string
      label: Grids
    nested:
      type: string
      label: 'Nested grids'

gridstack_breakpoints:
  type: mapping
  label: Breakpoints
  mapping:
    xs:
      type: gridstack_breakpoint
      label: XS
    sm:
      type: gridstack_breakpoint
      label: SM
    md:
      type: gridstack_breakpoint
      label: MD
    lg:
      type: gridstack_breakpoint
      label: LG
    xl:
      type: gridstack_breakpoint
      label: XL

# GridStack JS settings managed by UI.
gridstack_optionset:
  type: mapping
  label: 'Options'
  mapping:
    breakpoints:
      type: gridstack_breakpoints
    # @todo: Remove grids for breakpoints.
    grids:
      type: gridstack_grid
    icon:
      type: string
      label: Icon
    type:
      type: string
      label: Type
    use_framework:
      type: boolean
      label: 'Use static Grid framework'
    settings:
      type: mapping
      label: Settings
      mapping:
        alwaysShowResizeHandle:
          type: boolean
          label: 'Always show resize handle'
        auto:
          type: boolean
          label: Auto
        cellHeight:
          type: integer
          label: 'Cell height'
        disableDrag:
          type: boolean
          label: 'Disable drag'
        disableResize:
          type: boolean
          label: 'Disable resize'
        draggable:
          type: boolean
          label: Draggable
        float:
          type: boolean
          label: Float
        # @todo: Remove grids for breakpoints.
        isNested:
          type: boolean
          label: isNested
        minWidth:
          type: integer
          label: 'Min width'
        resizable:
          type: boolean
          label: Resizable
        rtl:
          type: boolean
          label: RTL
        staticGrid:
          type: boolean
          label: staticGrid
        verticalMargin:
          type: integer
          label: 'Vertical margin'
        noMargin:
          type: boolean
          label: 'No horizontal margin'
        # Introduced at v0.5.3.
        column:
          type: integer
          label: 'Amount of columns'
        maxRow:
          type: integer
          label: 'Maximum rows'

# Individual GridStack JS settings managed by UI.
gridstack.optionset.*:
  type: config_entity
  label: 'GridStack optionset'
  mapping:
    id:
      type: string
      label: ID
    name:
      type: string
      label: Name
    weight:
      type: integer
      label: Weight
    label:
      type: label
      label: Label
    uuid:
      type: string
      label: UUID
    json:
      type: gridstack_json
    options:
      type: gridstack_optionset
      label: Options

# HTML content/layout-related settings managed by GridStack plugins.
gridstack_vanilla:
  type: blazy_base
  label: 'GridStack display format vanilla settings'
  mapping: {}

gridstack_base:
  type: blazy_base
  label: 'GridStack display format base settings'
  mapping:
    caption:
      type: sequence
      label: Captions
      sequence:
        - type: string
          label: 'Caption field'
    stamp:
      type: sequence
      label: Stamps
      sequence:
        - type: string

field.formatter.settings.gridstack_image:
  type: gridstack_vanilla
  label: 'GridStack Image display format settings'

field.formatter.settings.gridstack_file:
  type: gridstack_vanilla
  label: 'GridStack File display format settings'

field.formatter.settings.gridstack_media:
  type: gridstack_vanilla
  label: 'GridStack Media display format settings'

field.formatter.settings.gridstack_paragraphs:
  type: gridstack_vanilla
  label: 'GridStack Paragraphs display format settings'

# @todo: Rework or remove this approach for gridstack_breakpoints above.
# You have a better idea, but doesn't always work out given limited time.
gridstack_node:
  type: mapping
  label: 'Grid nodes'
  mapping:
    x:
      type: integer
      label: X
    y:
      type: integer
      label: Y
    width:
      type: integer
      label: Width
    height:
      type: integer
      label: Height
    image_style:
      type: string
      label: 'Image style'

# @todo: Rework or remove this approach for gridstack_breakpoints above.
# You have a better idea, but doesn't always work out given limited time.
gridstack_grid:
  type: sequence
  label: Grids
  sequence:
    - type: mapping
      mapping:
        node:
          type: gridstack_node
          label: Nodes
        nested:
          type: string
          label: Nested