boundless-image

THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

Image

An image block with placeholder support for loading and fallback scenarios.

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

<tr>
    <td>src</td>
    <td><pre><code>string</code></pre></td>
    <td><pre><code class="language-js">'about:blank'</code></pre></td>
    <td>a valid path to the desired image</td>
</tr>

Name	Type	Default Value	Description

Optional Props

<tr>
    <td>alt</td>
    <td><pre><code>string</code></pre></td>
    <td><pre><code class="language-js">null</code></pre></td>
    <td>a written description of the image for search engines, hovertext and those using accessibility technologies; applied to the `.b-image` as the HTML attributes `alt` or `title`, depending on the type of rendered node</td>
</tr>

<tr>
    <td>displayAsBackgroundImage</td>
    <td><pre><code>bool</code></pre></td>
    <td><pre><code class="language-js">false</code></pre></td>
    <td>emits the image as a `<div>` with `background-image` css property set instead of `<img>`</td>
</tr>

<tr>
    <td>imageProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-image` node</td>
</tr>

<tr>
    <td>statusProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-image-status` node</td>
</tr>

Name	Type	Default Value	Description