# {py:mod}`simvx.core.ui.ansi_parser`

```{py:module} simvx.core.ui.ansi_parser
```

```{autodoc2-docstring} simvx.core.ui.ansi_parser
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`StyledSpan <simvx.core.ui.ansi_parser.StyledSpan>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan
    :summary:
    ```
````

### Functions

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

* - {py:obj}`parse_ansi <simvx.core.ui.ansi_parser.parse_ansi>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.parse_ansi
    :summary:
    ```
* - {py:obj}`strip_ansi <simvx.core.ui.ansi_parser.strip_ansi>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.strip_ansi
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.ui.ansi_parser.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.__all__
    :summary:
    ```
* - {py:obj}`DEFAULT_FG <simvx.core.ui.ansi_parser.DEFAULT_FG>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.DEFAULT_FG
    :summary:
    ```
* - {py:obj}`ANSI_COLORS <simvx.core.ui.ansi_parser.ANSI_COLORS>`
  - ```{autodoc2-docstring} simvx.core.ui.ansi_parser.ANSI_COLORS
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.ui.ansi_parser.__all__
:value: >
   ['StyledSpan', 'ANSI_COLORS', 'parse_ansi', 'strip_ansi']

```{autodoc2-docstring} simvx.core.ui.ansi_parser.__all__
```

````

````{py:data} DEFAULT_FG
:canonical: simvx.core.ui.ansi_parser.DEFAULT_FG
:type: tuple[float, float, float, float]
:value: >
   (1.0, 1.0, 1.0, 1.0)

```{autodoc2-docstring} simvx.core.ui.ansi_parser.DEFAULT_FG
```

````

`````{py:class} StyledSpan
:canonical: simvx.core.ui.ansi_parser.StyledSpan

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan
```

````{py:attribute} text
:canonical: simvx.core.ui.ansi_parser.StyledSpan.text
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan.text
```

````

````{py:attribute} color
:canonical: simvx.core.ui.ansi_parser.StyledSpan.color
:type: tuple[float, float, float, float]
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan.color
```

````

````{py:attribute} bg_color
:canonical: simvx.core.ui.ansi_parser.StyledSpan.bg_color
:type: tuple[float, float, float, float] | None
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan.bg_color
```

````

````{py:attribute} bold
:canonical: simvx.core.ui.ansi_parser.StyledSpan.bold
:type: bool
:value: >
   False

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan.bold
```

````

````{py:attribute} underline
:canonical: simvx.core.ui.ansi_parser.StyledSpan.underline
:type: bool
:value: >
   False

```{autodoc2-docstring} simvx.core.ui.ansi_parser.StyledSpan.underline
```

````

`````

````{py:data} ANSI_COLORS
:canonical: simvx.core.ui.ansi_parser.ANSI_COLORS
:type: list[tuple[float, float, float, float]]
:value: >
   [(0.0, 0.0, 0.0, 1.0), (0.8, 0.0, 0.0, 1.0), (0.0, 0.8, 0.0, 1.0), (0.8, 0.8, 0.0, 1.0), (0.0, 0.0, ...

```{autodoc2-docstring} simvx.core.ui.ansi_parser.ANSI_COLORS
```

````

````{py:function} parse_ansi(text: str) -> list[simvx.core.ui.ansi_parser.StyledSpan]
:canonical: simvx.core.ui.ansi_parser.parse_ansi

```{autodoc2-docstring} simvx.core.ui.ansi_parser.parse_ansi
```
````

````{py:function} strip_ansi(text: str) -> str
:canonical: simvx.core.ui.ansi_parser.strip_ansi

```{autodoc2-docstring} simvx.core.ui.ansi_parser.strip_ansi
```
````