SeoMetaFlat
katanakit-js / SeoMetaFlat
Interface: SeoMetaFlat
Section titled “Interface: SeoMetaFlat”Defined in: config/seo-meta.types.ts:48
Flat meta: HTML head essentials, Open Graph and optional Twitter/X cards.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
articleAuthor? |
readonly string[] |
- | SeoMetaArticle.articleAuthor |
config/seo-meta.types.ts:38 |
articleModifiedTime? |
string |
- | SeoMetaArticle.articleModifiedTime |
config/seo-meta.types.ts:39 |
articlePublishedTime? |
string |
- | SeoMetaArticle.articlePublishedTime |
config/seo-meta.types.ts:40 |
articleSection? |
string |
- | SeoMetaArticle.articleSection |
config/seo-meta.types.ts:41 |
articleTag? |
readonly string[] |
- | SeoMetaArticle.articleTag |
config/seo-meta.types.ts:42 |
author? |
string |
Meta author. | - | config/seo-meta.types.ts:63 |
canonical? |
string |
Explicit canonical URL → <link rel="canonical">. Prefer this over url when you know the preferred address. |
- | config/seo-meta.types.ts:68 |
charset? |
string |
- | - | config/seo-meta.types.ts:74 |
description? |
string |
Page summary → <meta name="description">. Prefer this for the page; use ogDescription only to override the share preview. |
- | config/seo-meta.types.ts:59 |
keywords? |
string |
Meta keywords (legacy; optional). | - | config/seo-meta.types.ts:61 |
ogDescription? |
string |
Open Graph description (og:description). Defaults to description when omitted. |
- | config/seo-meta.types.ts:90 |
ogImage? |
| string | SeoArrayable<SeoOgImageObject> |
- | - | config/seo-meta.types.ts:97 |
ogImageAlt? |
string |
- | - | config/seo-meta.types.ts:103 |
ogImageHeight? |
string | number |
- | - | config/seo-meta.types.ts:102 |
ogImageSecureUrl? |
string |
- | - | config/seo-meta.types.ts:99 |
ogImageType? |
string |
- | - | config/seo-meta.types.ts:100 |
ogImageUrl? |
string |
- | - | config/seo-meta.types.ts:98 |
ogImageWidth? |
string | number |
- | - | config/seo-meta.types.ts:101 |
ogLocale? |
string |
- | - | config/seo-meta.types.ts:92 |
ogSiteName? |
string |
Open Graph site name (og:site_name). Defaults to siteTitle when omitted. |
- | config/seo-meta.types.ts:96 |
ogTitle? |
string |
Open Graph title (og:title). Defaults to the resolved page title when omitted. |
- | config/seo-meta.types.ts:86 |
ogType? |
string |
- | - | config/seo-meta.types.ts:91 |
ogUrl? |
string |
Open Graph page URL (og:url). Falls back to canonical → url → site. |
- | config/seo-meta.types.ts:82 |
robots? |
string | SeoRobotsObject |
- | - | config/seo-meta.types.ts:76 |
title? |
string |
Page document title → <title>. Not the site brand (siteTitle). When both differ, the helper usually renders "Page | Brand". |
- | config/seo-meta.types.ts:54 |
twitterCard? |
"summary" | "summary_large_image" |
Twitter/X card size; defaults to summary_large_image when an image is available. |
- | config/seo-meta.types.ts:106 |
twitterCreator? |
string |
Twitter/X creator handle, e.g. "@katanakit". |
- | config/seo-meta.types.ts:118 |
twitterDescription? |
string |
Twitter/X description; defaults to the resolved Open Graph description. | - | config/seo-meta.types.ts:110 |
twitterImage? |
string |
Twitter/X image URL; defaults to the resolved Open Graph image. | - | config/seo-meta.types.ts:112 |
twitterImageAlt? |
string |
Alt text for the Twitter/X image. | - | config/seo-meta.types.ts:114 |
twitterSite? |
string |
Twitter/X site handle, e.g. "@katanakit". |
- | config/seo-meta.types.ts:116 |
twitterTitle? |
string |
Twitter/X title; defaults to the resolved Open Graph title. | - | config/seo-meta.types.ts:108 |
url? |
string |
Absolute page URL. Fallback for canonical / og:url when those are omitted (resolution order: ogUrl → canonical → url → site). |
- | config/seo-meta.types.ts:73 |
viewport? |
string | Record<string, string | number | undefined> |
- | - | config/seo-meta.types.ts:75 |