# {py:mod}`quirl.components.image`

```{py:module} quirl.components.image
```

```{autodocx-docstring} quirl.components.image
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`CircularSmartImage <quirl.components.image.CircularSmartImage>`
  - ```{autodocx-docstring} quirl.components.image.CircularSmartImage
    :summary:
    ```
* - {py:obj}`SmartImage <quirl.components.image.SmartImage>`
  - ```{autodocx-docstring} quirl.components.image.SmartImage
    :summary:
    ```
* - {py:obj}`SmartImagePlaceholder <quirl.components.image.SmartImagePlaceholder>`
  - ```{autodocx-docstring} quirl.components.image.SmartImagePlaceholder
    :summary:
    ```
````

### API

`````{py:class} CircularSmartImage(element: typing.Optional[str] = None, properties: typing.Optional[typing.Dict[str, str]] = None, props: typing.Optional[typing.Dict[str, str]] = None, style: typing.Optional[typing.Dict[str, str]] = None, inner_html: typing.Optional[typing.Union[str, str, float]] = None, children: typing.Optional[typing.List[duck.html.components.HtmlComponent]] = None, **kwargs)
:canonical: quirl.components.image.CircularSmartImage

Bases: {py:obj}`quirl.components.image.SmartImage`

```{autodocx-docstring} quirl.components.image.CircularSmartImage
```

```{rubric} Initialization
```

```{autodocx-docstring} quirl.components.image.CircularSmartImage.__init__
```

````{py:method} on_create()
:canonical: quirl.components.image.CircularSmartImage.on_create

```{autodocx-docstring} quirl.components.image.CircularSmartImage.on_create
```

````

`````

`````{py:class} SmartImage(element: typing.Optional[str] = None, properties: typing.Optional[typing.Dict[str, str]] = None, props: typing.Optional[typing.Dict[str, str]] = None, style: typing.Optional[typing.Dict[str, str]] = None, inner_html: typing.Optional[typing.Union[str, str, float]] = None, children: typing.Optional[typing.List[duck.html.components.HtmlComponent]] = None, **kwargs)
:canonical: quirl.components.image.SmartImage

Bases: {py:obj}`duck.html.components.container.Container`

```{autodocx-docstring} quirl.components.image.SmartImage
```

```{rubric} Initialization
```

```{autodocx-docstring} quirl.components.image.SmartImage.__init__
```

````{py:attribute} ERROR_ROLE
:canonical: quirl.components.image.SmartImage.ERROR_ROLE
:value: >
   'error'

```{autodocx-docstring} quirl.components.image.SmartImage.ERROR_ROLE
```

````

````{py:attribute} UNSET_ROLE
:canonical: quirl.components.image.SmartImage.UNSET_ROLE
:value: >
   'unset'

```{autodocx-docstring} quirl.components.image.SmartImage.UNSET_ROLE
```

````

````{py:method} build_image() -> duck.html.components.image.Image
:canonical: quirl.components.image.SmartImage.build_image

```{autodocx-docstring} quirl.components.image.SmartImage.build_image
```

````

````{py:method} build_placeholder(placeholder, role: str, visible: bool) -> duck.html.components.container.Container
:canonical: quirl.components.image.SmartImage.build_placeholder

```{autodocx-docstring} quirl.components.image.SmartImage.build_placeholder
```

````

````{py:attribute} docs_preview_kwargs
:canonical: quirl.components.image.SmartImage.docs_preview_kwargs
:value: >
   None

```{autodocx-docstring} quirl.components.image.SmartImage.docs_preview_kwargs
```

````

````{py:method} on_create()
:canonical: quirl.components.image.SmartImage.on_create

```{autodocx-docstring} quirl.components.image.SmartImage.on_create
```

````

`````

`````{py:class} SmartImagePlaceholder(element: typing.Optional[str] = None, properties: typing.Optional[typing.Dict[str, str]] = None, props: typing.Optional[typing.Dict[str, str]] = None, style: typing.Optional[typing.Dict[str, str]] = None, inner_html: typing.Optional[typing.Union[str, str, float]] = None, children: typing.Optional[typing.List[duck.html.components.HtmlComponent]] = None, **kwargs)
:canonical: quirl.components.image.SmartImagePlaceholder

Bases: {py:obj}`duck.html.components.container.Container`

```{autodocx-docstring} quirl.components.image.SmartImagePlaceholder
```

```{rubric} Initialization
```

```{autodocx-docstring} quirl.components.image.SmartImagePlaceholder.__init__
```

````{py:attribute} GLYPH_SOURCE
:canonical: quirl.components.image.SmartImagePlaceholder.GLYPH_SOURCE
:value: >
   "data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stro..."

```{autodocx-docstring} quirl.components.image.SmartImagePlaceholder.GLYPH_SOURCE
```

````

````{py:method} on_create()
:canonical: quirl.components.image.SmartImagePlaceholder.on_create

```{autodocx-docstring} quirl.components.image.SmartImagePlaceholder.on_create
```

````

`````