Skip to content
Brezel Internal Docs
Blog

WidgetComponentOptions

Defined in: layout/types.ts:300

Options for layout components.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

widget?

Section titled “widget?”

optional widget?: WidgetType

Defined in: layout/types.ts:302

X-intellij-html-description

Section titled “X-intellij-html-description”

Type of the widget to use.

\n
    \n
  • custom: Custom widget
    • \n
  • donut: Donut chart
    • \n
  • history: History chart
    • \n
  • kanban: Kanban board
    • \n
  • permissions: Permissions widget
    • \n
  • scan: Scan widget
    • \n
  • bar: Bar chart
    • \n
  • column: Column chart
    • \n
  • line: Line chart
    • \n
  • progress: Progress widget
    • \n
  • radar: Radar chart
    • \n

dynamic_height?

Section titled “dynamic_height?”

optional dynamic_height?: boolean

Defined in: layout/types.ts:303

hidden_from_frontend?

Section titled “hidden_from_frontend?”

optional hidden_from_frontend?: boolean

Defined in: layout/types.ts:120

Inherited from

Section titled “Inherited from”

ComponentOptions.hidden_from_frontend

show_in?

Section titled “show_in?”

optional show_in?: DefinedModuleAction[]

Defined in: layout/types.ts:121

Inherited from

Section titled “Inherited from”

ComponentOptions.show_in

recipes?

Section titled “recipes?”

optional recipes?: LayoutElementRecipes | { widget?: string; dynamic_height?: string; hidden_from_frontend?: string; show_in?: string; recipes?: string; }

Defined in: layout/types.ts:122

Union Members

Section titled “Union Members”

LayoutElementRecipes

Type Literal
Section titled “Type Literal”

{ widget?: string; dynamic_height?: string; hidden_from_frontend?: string; show_in?: string; recipes?: string; }

widget?
Section titled “widget?”

optional widget?: string

X-intellij-html-description
Section titled “X-intellij-html-description”

Type of the widget to use.

\n
    \n
  • custom: Custom widget
    • \n
  • donut: Donut chart
    • \n
  • history: History chart
    • \n
  • kanban: Kanban board
    • \n
  • permissions: Permissions widget
    • \n
  • scan: Scan widget
    • \n
  • bar: Bar chart
    • \n
  • column: Column chart
    • \n
  • line: Line chart
    • \n
  • progress: Progress widget
    • \n
  • radar: Radar chart
    • \n
dynamic_height?
Section titled “dynamic_height?”

optional dynamic_height?: string

hidden_from_frontend?
Section titled “hidden_from_frontend?”

optional hidden_from_frontend?: string

show_in?
Section titled “show_in?”

optional show_in?: string

recipes?
Section titled “recipes?”

optional recipes?: string

Inherited from

Section titled “Inherited from”

ComponentOptions.recipes