ArdoLabels
On this page
import type { ArdoLabels } from "ardo/ui"
type ArdoLabels = {
breadcrumb: {
label: string;
};
container: ArdoContainerLabels;
copyButton: {
copy: string;
copied: string;
copyCode: string;
copyFailed: string;
manualCode: string;
};
footer: {
builtOn: string;
builtWithArdo: string;
sponsoredBy: string;
};
header: {
toggleMenu: string;
};
layout: {
skipToContent: string;
};
mobilePanel: {
closeMenu: string;
home: string;
navigationMenu: string;
titledNavigationMenu: (title: string) => string;
};
search: {
clear: string;
closeOverlay: string;
close: string;
label: string;
loading: string;
loadError: string;
navigate: string;
noResults: (query: string) => string;
placeholder: string;
resultCount: (count: number) => string;
results: string;
retry: string;
select: string;
};
sidebar: {
collapse: string;
expand: string;
mainNavigation: string;
};
siteControls: {
appearance: string;
language: string;
links: string;
version: string;
/** Banner text on a version other than the latest. */
olderVersion: (version: string) => string;
/** Banner link to the latest version. */
latestVersion: (version: string) => string;
};
toc: {
label: string;
navLabel: string;
};
};
Properties
| Name | Type | Required |
|---|---|---|
breadcrumb | { label: string } | Yes |
container | ArdoContainerLabels | Yes |
copyButton | { copy: string; copied: string; copyCode: string; copyFailed: string; manualCode: string } | Yes |
footer | { builtOn: string; builtWithArdo: string; sponsoredBy: string } | Yes |
header | { toggleMenu: string } | Yes |
layout | { skipToContent: string } | Yes |
mobilePanel | { closeMenu: string; home: string; navigationMenu: string; titledNavigationMenu: (title: string) => string } | Yes |
search | { clear: string; closeOverlay: string; close: string; label: string; loading: string; loadError: string; navigate: string; noResults: (query: string) => string; placeholder: string; resultCount: (count: number) => string; results: string; retry: string; select: string } | Yes |
sidebar | { collapse: string; expand: string; mainNavigation: string } | Yes |
siteControls | { appearance: string; language: string; links: string; version: string; olderVersion: (version: string) => string; latestVersion: (version: string) => string } | Yes |
toc | { label: string; navLabel: string } | Yes |