---
orphan: true
---

# {py:mod}`ros_sugar.ui_node.elements`

```{py:module} ros_sugar.ui_node.elements
```

```{autodoc2-docstring} ros_sugar.ui_node.elements
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Task <ros_sugar.ui_node.elements.Task>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.Task
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`filter_tag_button <ros_sugar.ui_node.elements.filter_tag_button>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.filter_tag_button
    :summary:
    ```
* - {py:obj}`add_additional_ui_elements <ros_sugar.ui_node.elements.add_additional_ui_elements>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.add_additional_ui_elements
    :summary:
    ```
* - {py:obj}`styled_main_service_clients_container <ros_sugar.ui_node.elements.styled_main_service_clients_container>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_service_clients_container
    :summary:
    ```
* - {py:obj}`input_topic_card <ros_sugar.ui_node.elements.input_topic_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.input_topic_card
    :summary:
    ```
* - {py:obj}`styled_main_inputs_container <ros_sugar.ui_node.elements.styled_main_inputs_container>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_inputs_container
    :summary:
    ```
* - {py:obj}`styled_inputs_grid <ros_sugar.ui_node.elements.styled_inputs_grid>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_inputs_grid
    :summary:
    ```
* - {py:obj}`output_topic_card <ros_sugar.ui_node.elements.output_topic_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.output_topic_card
    :summary:
    ```
* - {py:obj}`styled_main_outputs_container <ros_sugar.ui_node.elements.styled_main_outputs_container>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_outputs_container
    :summary:
    ```
* - {py:obj}`styled_outputs_grid <ros_sugar.ui_node.elements.styled_outputs_grid>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_outputs_grid
    :summary:
    ```
* - {py:obj}`output_logging_card <ros_sugar.ui_node.elements.output_logging_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.output_logging_card
    :summary:
    ```
* - {py:obj}`initial_logging_card <ros_sugar.ui_node.elements.initial_logging_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.initial_logging_card
    :summary:
    ```
* - {py:obj}`remove_child_from_logging_card <ros_sugar.ui_node.elements.remove_child_from_logging_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.remove_child_from_logging_card
    :summary:
    ```
* - {py:obj}`augment_text_in_logging_card <ros_sugar.ui_node.elements.augment_text_in_logging_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.augment_text_in_logging_card
    :summary:
    ```
* - {py:obj}`update_logging_card <ros_sugar.ui_node.elements.update_logging_card>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.update_logging_card
    :summary:
    ```
* - {py:obj}`update_logging_card_with_loading <ros_sugar.ui_node.elements.update_logging_card_with_loading>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.update_logging_card_with_loading
    :summary:
    ```
* - {py:obj}`settings_ui_element <ros_sugar.ui_node.elements.settings_ui_element>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.settings_ui_element
    :summary:
    ```
* - {py:obj}`component_settings_div <ros_sugar.ui_node.elements.component_settings_div>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.component_settings_div
    :summary:
    ```
* - {py:obj}`nonvalidated_config <ros_sugar.ui_node.elements.nonvalidated_config>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.nonvalidated_config
    :summary:
    ```
* - {py:obj}`validated_config <ros_sugar.ui_node.elements.validated_config>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.validated_config
    :summary:
    ```
* - {py:obj}`parse_ui_elements_to_simple_and_nested <ros_sugar.ui_node.elements.parse_ui_elements_to_simple_and_nested>`
  - ```{autodoc2-docstring} ros_sugar.ui_node.elements.parse_ui_elements_to_simple_and_nested
    :summary:
    ```
````

### API

`````{py:class} Task(name: str, client_type: str, fields)
:canonical: ros_sugar.ui_node.elements.Task

```{autodoc2-docstring} ros_sugar.ui_node.elements.Task
```

````{py:method} is_active() -> bool
:canonical: ros_sugar.ui_node.elements.Task.is_active

```{autodoc2-docstring} ros_sugar.ui_node.elements.Task.is_active
```

````

````{py:method} update(*, status: typing.Optional[str] = None, feedback: typing.Any = None, duration: typing.Optional[float] = None)
:canonical: ros_sugar.ui_node.elements.Task.update

```{autodoc2-docstring} ros_sugar.ui_node.elements.Task.update
```

````

````{py:property} card
:canonical: ros_sugar.ui_node.elements.Task.card
:type: FT

```{autodoc2-docstring} ros_sugar.ui_node.elements.Task.card
```

````

````{py:property} feedback
:canonical: ros_sugar.ui_node.elements.Task.feedback

```{autodoc2-docstring} ros_sugar.ui_node.elements.Task.feedback
```

````

`````

````{py:function} filter_tag_button(name: str, div_to_hide: str, **kwargs)
:canonical: ros_sugar.ui_node.elements.filter_tag_button

```{autodoc2-docstring} ros_sugar.ui_node.elements.filter_tag_button
```
````

````{py:function} add_additional_ui_elements(input_elements: typing.Optional[typing.List[Tuple]], output_elements: typing.Optional[typing.List[Tuple]])
:canonical: ros_sugar.ui_node.elements.add_additional_ui_elements

```{autodoc2-docstring} ros_sugar.ui_node.elements.add_additional_ui_elements
```
````

````{py:function} styled_main_service_clients_container(srv_clients_config: Sequence[typing.Dict], container_name: str, column_class: str = '') -> FT
:canonical: ros_sugar.ui_node.elements.styled_main_service_clients_container

```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_service_clients_container
```
````

````{py:function} input_topic_card(topic_name: str, topic_type: str, ros_msg_type: type, column_class: str = '', ft_has_map_element: bool = False) -> FT
:canonical: ros_sugar.ui_node.elements.input_topic_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.input_topic_card
```
````

````{py:function} styled_main_inputs_container(inputs_grid_div_id: str) -> FT
:canonical: ros_sugar.ui_node.elements.styled_main_inputs_container

```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_inputs_container
```
````

````{py:function} styled_inputs_grid(number_of_inputs: int) -> tuple
:canonical: ros_sugar.ui_node.elements.styled_inputs_grid

```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_inputs_grid
```
````

````{py:function} output_topic_card(topic_name: str, topic_type: str, column_class: str = '', map_output_markers: typing.Optional[typing.Dict] = None) -> FT
:canonical: ros_sugar.ui_node.elements.output_topic_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.output_topic_card
```
````

````{py:function} styled_main_outputs_container(outputs_grid_div_id: str) -> FT
:canonical: ros_sugar.ui_node.elements.styled_main_outputs_container

```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_main_outputs_container
```
````

````{py:function} styled_outputs_grid(number_of_outputs: int) -> tuple
:canonical: ros_sugar.ui_node.elements.styled_outputs_grid

```{autodoc2-docstring} ros_sugar.ui_node.elements.styled_outputs_grid
```
````

````{py:function} output_logging_card(current_log)
:canonical: ros_sugar.ui_node.elements.output_logging_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.output_logging_card
```
````

````{py:function} initial_logging_card()
:canonical: ros_sugar.ui_node.elements.initial_logging_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.initial_logging_card
```
````

````{py:function} remove_child_from_logging_card(logging_card, target_id='loading-dots')
:canonical: ros_sugar.ui_node.elements.remove_child_from_logging_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.remove_child_from_logging_card
```
````

````{py:function} augment_text_in_logging_card(logging_card, new_txt: str, target_id='text')
:canonical: ros_sugar.ui_node.elements.augment_text_in_logging_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.augment_text_in_logging_card
```
````

````{py:function} update_logging_card(logging_card, output: str, data_type: str, data_src: str = 'info')
:canonical: ros_sugar.ui_node.elements.update_logging_card

```{autodoc2-docstring} ros_sugar.ui_node.elements.update_logging_card
```
````

````{py:function} update_logging_card_with_loading(logging_card)
:canonical: ros_sugar.ui_node.elements.update_logging_card_with_loading

```{autodoc2-docstring} ros_sugar.ui_node.elements.update_logging_card_with_loading
```
````

````{py:function} settings_ui_element(setting_name: str, setting_details: dict, field_type, type_args, input_name=None)
:canonical: ros_sugar.ui_node.elements.settings_ui_element

```{autodoc2-docstring} ros_sugar.ui_node.elements.settings_ui_element
```
````

````{py:function} component_settings_div(component_name: str, settings_col_cls: str, ui_elements, nested_ui_elements)
:canonical: ros_sugar.ui_node.elements.component_settings_div

```{autodoc2-docstring} ros_sugar.ui_node.elements.component_settings_div
```
````

````{py:function} nonvalidated_config(setting_name: str, value: typing.Any, field_type: str, type_args, input_name: str)
:canonical: ros_sugar.ui_node.elements.nonvalidated_config

```{autodoc2-docstring} ros_sugar.ui_node.elements.nonvalidated_config
```
````

````{py:function} validated_config(setting_name: str, value: typing.Any, attrs_validators: typing.List[typing.Dict], field_type, type_args, input_name)
:canonical: ros_sugar.ui_node.elements.validated_config

```{autodoc2-docstring} ros_sugar.ui_node.elements.validated_config
```
````

````{py:function} parse_ui_elements_to_simple_and_nested(component_name: str, setting_name: str, setting_details: typing.Any, simple_ui_elements: list, nested_ui_elements: list)
:canonical: ros_sugar.ui_node.elements.parse_ui_elements_to_simple_and_nested

```{autodoc2-docstring} ros_sugar.ui_node.elements.parse_ui_elements_to_simple_and_nested
```
````