Options
All
  • Public
  • Public/Protected
  • All
Menu

Module app/store-types

Index

Type Aliases

Type Aliases

FlagIndex

FlagIndex: {}

Utility type to create key:boolean index object

Type declaration

  • [key: string]: boolean

PanelConfig

PanelConfig: { id: string; name: string; icon: string; label: string }

Panel rendered in a Pane.

Type declaration

  • id: string

    Id of the Panel to be rendered

  • name: string

    Name of the Panel to be rendered

  • icon: string

    Icon of the Panel to be rendered

  • label: string

    Label of the Panel to be rendered

View

View: { name?: string }

UI Component rendered in a Pane

Type declaration

  • [key: string]: any
  • Optional name?: string

PaneProps

PaneProps: { isRoot?: boolean; isVGroup?: boolean; isHGroup?: boolean; isClosable?: boolean; isClosed?: boolean; minWidth?: number; minHeight?: number; dropAllowed?: FlagIndex; dropDenied?: FlagIndex; isLocked?: boolean; noBorder?: boolean; hasAutosize?: boolean; noOverflow?: boolean; isMovedPane?: boolean }

Properties of the Pane. This decides the behaviour of the Pane

Type declaration

  • Optional isRoot?: boolean

    Whether the Pane is the Worksapce root or not

  • Optional isVGroup?: boolean

    Whether the Pane is a vertical group or not

  • Optional isHGroup?: boolean

    Whether the Pane is a horizontal group or not

  • Optional isClosable?: boolean

    Whether the Pane is a closable or not

  • Optional isClosed?: boolean

    Whether the Pane is a currently closed

  • Optional minWidth?: number

    Minimum Width of the Pane

  • Optional minHeight?: number

    Minimum Height of the Pane

  • Optional dropAllowed?: FlagIndex

    Index of components which can be dropped on the Pane

  • Optional dropDenied?: FlagIndex

    Index of components which cannot be dropped on the Pane

  • Optional isLocked?: boolean

    Whether the Pane is locked or not. If true the Pane cannot be moved or resized

  • Optional noBorder?: boolean

    Whether the border of the Pane is hidden

  • Optional hasAutosize?: boolean

    Whether the Pane adjusts its size automatically

  • Optional noOverflow?: boolean

    Whether the Pane hides content overflow

  • Optional isMovedPane?: boolean

    Whether the Pane just completed a move operation

PaneSettings

PaneSettings: { active?: number; tabs?: Panel[]; view?: View }

Settings of the Pane. This decides the content in the Pane and how it is rendered

Type declaration

  • Optional active?: number

    Index of active tab

  • Optional tabs?: Panel[]

    List of Panels

  • Optional view?: View

    Details of the UI component to be rendered in the Pane

PaneType

PaneType: "pane" | "group"

Type of the Pane.

PanePlacement

PanePlacement: "root" | "container" | "container:main" | "container:left" | "container:left:inner" | "container:right" | "container:right:inner" | "container:center" | "container:center:main" | "container:center:bottom" | "container:center:bottom:inner" | "container:bottom" | ""

Position of the Pane in the Workspace

PaneConfig

PaneConfig: { id: string; type: PaneType; placement: PanePlacement; size?: string | number; props?: PaneProps; settings?: PaneSettings; children?: PaneConfig[] }

Configurarion of the Pane

Type declaration

  • id: string

    Unique Id of the Pane

  • type: PaneType

    Type of the pane

  • placement: PanePlacement

    Position of the Pane

  • Optional size?: string | number

    Size of the Pane. This can set as "auto" | "px" | number

  • Optional props?: PaneProps

    Properties of the Pane declared in PaneProps. This decides the behaviour of the Pane

  • Optional settings?: PaneSettings

    Settings of the Pane declared in PaneSettings. This decides the content in the Pane and how it is rendered

  • Optional children?: PaneConfig[]

    List of child Panes of the Pane. Used only when Pane type is "group"

WorkspaceConfig

WorkspaceConfig: { root?: PaneConfig }

Configurarion of the whole Workspace

Type declaration

  • Optional root?: PaneConfig

    Pane at the root. This Pane contains the whole Workspace

WorkspaceItem

WorkspaceItem: { id: string; name: string; type: "default" | "custom"; data: string; initData: string; isActive: boolean }

Workspace preset. User can load the predefined/saved Workspace

Type declaration

  • id: string

    Workspace preset unique id

  • name: string

    Workspace preset name

  • type: "default" | "custom"

    Workspace preset type. "default" - predefined. "custom" - created and save by the User.

  • data: string

    Current Workspace configuration

  • initData: string

    Initial Workspace configuration

  • isActive: boolean

    Whether is Workspace is active or not

Pane

Pane: { id: string; type?: string; placement?: string; size?: string | number; props?: PaneProps; settings?: PaneSettings; children?: Pane[]; parent?: Pane; next?: Pane; prev?: Pane }

Rendered Pane instance from a PanceConfig

Type declaration

  • id: string

    Unique Id of the Pane

  • Optional type?: string

    Type of the pane

  • Optional placement?: string

    Position of the Pane

  • Optional size?: string | number

    Size of the Pane. This can set as "auto" | "px" | number

  • Optional props?: PaneProps

    Properties of the Pane declared in PaneProps. This decides the behaviour of the Pane

  • Optional settings?: PaneSettings

    Settings of the Pane declared in PaneSettings. This decides the content in the Pane and how it is rendered

  • Optional children?: Pane[]

    List of child Panes of the Pane. Used only when Pane type is "group"

  • Optional parent?: Pane

    Parent Pane

  • Optional next?: Pane

    Next Pane in the PaneGroup

  • Optional prev?: Pane

    Previous Pane in the PaneGroup

DropInfo

DropInfo: { dropArea?: string }

Type declaration

  • Optional dropArea?: string

Generated using TypeDoc