# OgImageOptions

<pre class="nacara-api__signature"><code><span class="tok-keyword">type</span> <span class="tok-type">OgImageOptions</span> <span class="tok-operator">=</span>
    <span class="tok-punctuation">{</span>
        <a class="tok-property" href="#frontmatterkeys">FrontMatterKeys</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
        <a class="tok-property" href="#altkeys">AltKeys</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
        <a class="tok-property" href="#fallback">Fallback</a><span class="tok-punctuation">:</span> <span class="tok-type">Page</span> <span class="tok-operator">-&gt;</span> <a class="tok-type" href="/Partas.Nacara.Plugins/reference/partas-nacara-plugins-ogimage/nacara-plugins/ogimage/">OgImage</a> <span class="tok-type">option</span>
        <a class="tok-property" href="#default">Default</a><span class="tok-punctuation">:</span> <a class="tok-type" href="/Partas.Nacara.Plugins/reference/partas-nacara-plugins-ogimage/nacara-plugins/ogimage/">OgImage</a> <span class="tok-type">option</span>
        <a class="tok-property" href="#excludecollections">ExcludeCollections</a><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span>
    <span class="tok-punctuation">}</span></code></pre>

| | |
|---|---|
| Assembly | `Partas.Nacara.Plugins.OgImage` |

Options of the og-image plugin.

## Fields

<div class="nacara-api__entry" id="frontmatterkeys">
<a class="nacara-api__anchor"
                           href="#frontmatterkeys"
                           aria-label="Link to FrontMatterKeys"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">FrontMatterKeys</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

The front matter keys a page names its image under, first match wins.

The value is a path or url, or a mapping with `url`, `alt`, `width`
and `height`. `false` opts the page out, fallbacks included.



Defaults to `[ "og_image"; "ogImage"; "image" ]`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="altkeys">
<a class="nacara-api__anchor"
                           href="#altkeys"
                           aria-label="Link to AltKeys"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">AltKeys</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

The front matter keys the image's alt text is read from, beside a plain path.

Defaults to `[ "og_image_alt"; "ogImageAlt"; "image_alt" ]`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="fallback">
<a class="nacara-api__anchor"
                           href="#fallback"
                           aria-label="Link to Fallback"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Fallback</span><span class="tok-punctuation">:</span> <span class="tok-type">Page</span> <span class="tok-operator">-&gt;</span> <a class="tok-type" href="/Partas.Nacara.Plugins/reference/partas-nacara-plugins-ogimage/nacara-plugins/ogimage/">OgImage</a> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

The image of a page whose front matter names none.

Asked before `Default`, so a collection or a section can have its own card:
`fun page -> if page.Collection = "blog" then Some(OgImage.image "/blog-card.png") else None`.


Defaults to `fun _ -> None`.


</div>
</details>
</div>

<div class="nacara-api__entry" id="default">
<a class="nacara-api__anchor"
                           href="#default"
                           aria-label="Link to Default"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">Default</span><span class="tok-punctuation">:</span> <a class="tok-type" href="/Partas.Nacara.Plugins/reference/partas-nacara-plugins-ogimage/nacara-plugins/ogimage/">OgImage</a> <span class="tok-type">option</span></code></pre>
</summary>
<div class="nacara-api__body">

The image of every page nothing else gave one.

Defaults to `None`, which leaves such a page without an image.


</div>
</details>
</div>

<div class="nacara-api__entry" id="excludecollections">
<a class="nacara-api__anchor"
                           href="#excludecollections"
                           aria-label="Link to ExcludeCollections"
                           data-pagefind-ignore></a>
<details class="nacara-api__member">
<summary>
<pre class="nacara-api__signature nacara-api__signature--hanging"><code><span class="tok-property">ExcludeCollections</span><span class="tok-punctuation">:</span> <span class="tok-type">string</span> <span class="tok-type">list</span></code></pre>
</summary>
<div class="nacara-api__body">

Collections whose pages get no image at all.

Defaults to `[]`.


</div>
</details>
</div>
