Documentation

Module

ConfigView

Methods

# inner ClusterTable(props) → {React.ReactElement}

Parameters:
Name Type Attributes Description
props object
field object field object to render
field.value object value of the field
field.value.headers object headers of the table
field.value.rows object rows of the table
field.label object <optional>
 label of the field

View Source stories/ConfigView/ConfigView.jsx, line 314

the cluster table
React.ReactElement

# inner ConfigView(props) → {React.ReactElement}

Parameters:
Name Type Attributes Description
props object
sections array array of sections to render
dynamicComponents object <optional>
 object of dynamic components to render
isLoading boolean <optional>
 boolean to indicate if the view is loading
options object <optional>
 options object
options.fieldValueComponent React.ReactElement <optional>
 component to use for field values. Use to completely control the rendering of field values
options.linkComponent React.ReactElement <optional>
 component to use for links. If fieldValueComponent this property will be ignored

View Source stories/ConfigView/ConfigView.jsx, line 22

- returns rendered view
React.ReactElement

# inner FieldValue(props) → {React.ReactElement}

Render the value of a field
Parameters:
Name Type Description
props object
field object field object to render

View Source stories/ConfigView/ConfigView.jsx, line 172

- returns rendered field
React.ReactElement

# inner LinkValue(props) → {React.ReactElement}

Render the value of a link
Parameters:
Name Type Attributes Description
props object
field object field object to render
link object | string link object to render
link.id string id of the link
link.label string label of the link
link.name string <optional>
 name of the link (fallback if label is not present)
index number index of the link

View Source stories/ConfigView/ConfigView.jsx, line 202

- returns rendered link
React.ReactElement

# inner ViewColumns(props) → {React.ReactElement}

Parameters:
Name Type Description
props object
areas object field object to render

View Source stories/ConfigView/ConfigView.jsx, line 111

- returns rendered columnss
React.ReactElement

# inner ViewField(props) → {React.ReactElement}

Parameters:
Name Type Attributes Description
props object
field object field object to render
field.type string type of field to render
field.label string <optional>
 text to render

View Source stories/ConfigView/ConfigView.jsx, line 244

- returns rendered field
React.ReactElement

# inner ViewRows(props) → {React.ReactElement}

Parameters:
Name Type Description
props object
areas object field object to render

View Source stories/ConfigView/ConfigView.jsx, line 136

- returns rendered rows
React.ReactElement

# inner ViewSection(props) → {React.ReactElement}

renders a view section
Parameters:
Name Type Description
props object
section object field object to render
index number index of the field

View Source stories/ConfigView/ConfigView.jsx, line 61

- returns rendered section
React.ReactElement