Lowdefy
v3.17.2/context/PageHSCF/

PageHSCF

areas: content, footer, header, sider

Page HSCF provides a minimal layout structure for a page container with a header, sider, content, and footer arrangement.

header
content
id: block_id
type: PageHSCF

properties:
content:
Content css style object.
footer:
Footer css style object.
header:
-------
Header color.
Header css style object.
Header theme color.
main:
Main css style object.
sider:
sm
Breakpoint of the responsive layout.
Width of the collapsed sidebar, by setting to 0 a special trigger will appear.
Whether can be collapsed.
-------
Sider color
Set the initial collapsed state.
Direction of arrow, for a sider that expands from the right.
Css style object to apply to sider.
Color theme of the sidebar
Width of the sidebar.
Css style object to apply to layout.
type: object
properties:
  events:
    additionalProperties: false
    properties:
      onBreakpoint:
        type: array
      onEnter:
        description: >-
          Trigger actions every time a context is mounted and keep the page in
          loading until all actions have finished.
        type: array
      onEnterAsync:
        description: >-
          Trigger actions every time a context is mounted and do not keep the page
          in loading.
        type: array
      onInit:
        description: >-
          Trigger actions the first time a context is mounted and keep the page in
          loading until all actions have finished.
        type: array
      onInitAsync:
        description: >-
          Trigger actions the first time a context is mounted and do not keep the
          page in loading.
        type: array
      onSiderClose:
        description: Trigger actions when sider is closed.
        type: array
      onSiderOpen:
        description: Trigger actions when sider is opened.
        type: array
    type: object
  properties:
    additionalProperties: false
    properties:
      content:
        additionalProperties: false
        description: Content properties.
        properties:
          style:
            description: Content css style object.
            type: object
        type: object
      footer:
        additionalProperties: false
        description: Footer properties.
        properties:
          style:
            description: Footer css style object.
            type: object
        type: object
      header:
        additionalProperties: false
        description: Header properties.
        properties:
          color:
            description: Header color.
            type: string
          style:
            description: Header css style object.
            type: object
          theme:
            default: dark
            description: Header theme color.
            enum:
              - light
              - dark
            type: string
        type: object
      main:
        additionalProperties: false
        description: Main layout properties.
        properties:
          style:
            description: Main css style object.
            type: object
        type: object
      sider:
        additionalProperties: false
        description: Sider properties.
        properties:
          breakpoint:
            default: sm
            description: Breakpoint of the responsive layout.
            enum:
              - xs
              - sm
              - md
              - lg
              - xl
              - xxl
            type: string
          collapsedWidth:
            description: >-
              Width of the collapsed sidebar, by setting to 0 a special trigger
              will appear.
            type: integer
          collapsible:
            default: true
            description: Whether can be collapsed.
            type: boolean
          color:
            description: Sider color
            type: string
          initialCollapsed:
            default: true
            description: Set the initial collapsed state.
            type: boolean
          reverseArrow:
            default: false
            description: Direction of arrow, for a sider that expands from the right.
            type: boolean
          style:
            description: Css style object to apply to sider.
            type: object
          theme:
            default: light
            description: Color theme of the sidebar
            enum:
              - light
              - dark
            type: string
          width:
            description: Width of the sidebar.
            type:
              - string
              - number
        type: object
      style:
        description: Css style object to apply to layout.
        type: object
    type: object