virtuals/i18n/client

Variables

$i18n

const $i18n: any;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:80^

An i18n (internationalization) utility instance for client-side usage.

Remarks

This instance is created using the createI18n function, initialized with the current locale and a base locale. It provides a get method to asynchronously retrieve translations for a given UI translation key from the localeMap.

Example

const translation = await $i18n.get('welcome_message');

See

createI18n

Param

The current locale store or value.

Param

The default language to use as a base locale.

Param

An object mapping translation keys to their localized strings.

---

$locale

const $locale: any;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:48^

A locale store derived from the user’s locale settings and browser detection.

---

$localeSettings

const $localeSettings: any;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:40^

A persistent atom representing the user’s locale settings.

---

baseTranslation

const baseTranslation: {
  @studiocms/auth:login: {
     allow-registration-noaccount: string;
     allow-registration-register: string;
     demo-mode-credentials: string;
     description: string;
     email-label: string;
     forgot-password: string;
     forgot-password-message: string;
     forgot-password-title: string;
     header: string;
     login-button: string;
     password-label: string;
     sub-header-noprovider: string;
     sub-header-oauth: string;
     sub-header-usernamepassword: string;
     sub-header-usernamepasswordoauth: string;
     title: string;
     username-label: string;
  };
  @studiocms/auth:logout: {
     description: string;
     title: string;
  };
  @studiocms/auth:oauth-stack: {
     or-login-with: string;
  };
  @studiocms/auth:signup: {
     allow-login-haveaccount: string;
     allow-login-login: string;
     confirm-password-label: string;
     create-account-button: string;
     description: string;
     displayname-label: string;
     email-label: string;
     header: string;
     password-label: string;
     sub-header-noprovider: string;
     sub-header-oauth: string;
     sub-header-usernamepassword: string;
     sub-header-usernamepasswordoauth: string;
     title: string;
     username-label: string;
  };
  @studiocms/dashboard:404: {
     back-button: string;
     description: string;
     sub-description: string;
     title: string;
  };
  @studiocms/dashboard:configuration: {
     dashboard-grid-label: string;
     description: string;
     header: string;
     input-custom-login-page: string;
     input-diff-tracking-limit: string;
     input-og-image: string;
     input-site-description: string;
     input-site-icon: string;
     input-site-title: string;
     login-page-preview: string;
     save-button: string;
     select-hide-default-index: string;
     select-login-page-bg: string;
     select-page-diff-tracking: string;
     select-smtp-mailer: string;
     title: string;
  };
  @studiocms/dashboard:content-diff: {
     edited-by: string;
     edited-on: string;
     no-metadata-changes: string;
     page-content: string;
     page-metadata: string;
     page-title: string;
     revert-all: string;
     revert-content: string;
     revert-metadata: string;
     view-page: string;
  };
  @studiocms/dashboard:content-folder: {
     input-folder-name: string;
     input-folder-parent: string;
  };
  @studiocms/dashboard:content-header: {
     create-button: string;
     create-folder-title: string;
     create-page-title: string;
     delete-button: string;
     delete-folder-modal-desc-1: string;
     delete-folder-modal-desc-2: string;
     delete-modal-desc-1: string;
     delete-modal-desc-2: string;
     delete-modal-header: string;
     delete-modal-warning: string;
     draft-button: string;
     edit-folder-title: string;
     edit-page-title: string;
     publish-button: string;
     save-button: string;
     title: string;
  };
  @studiocms/dashboard:content-index: {
     description: string;
     header: string;
     placeholder: string;
     title: string;
  };
  @studiocms/dashboard:content-page: {
     custom-page-type-fields-header: string;
     custom-page-types-description-new: string;
     diff-edited-by-1: string;
     diff-edited-by-2: string;
     diff-no-history: string;
     input-page-description: string;
     input-page-hero-image: string;
     input-page-slug: string;
     input-page-title: string;
     select-page-categories: string;
     select-page-draft: string;
     select-page-parent-folder: string;
     select-page-show-author: string;
     select-page-show-contributors: string;
     select-page-show-in-nav: string;
     select-page-tags: string;
     select-page-type: string;
     tab-label-basic-info: string;
     tab-label-content: string;
     tab-label-diff: string;
  };
  @studiocms/dashboard:content-sidebar: {
     dropdown-create-folder: string;
     dropdown-create-page: string;
     input-placeholder-search: string;
     items-divider: string;
  };
  @studiocms/dashboard:index: {
     description: string;
     sub-header: string;
     title: string;
     title-button:discord: string;
     title-button:feedback: string;
     welcome-title: string;
  };
  @studiocms/dashboard:password-reset: {
     confirm-password-label: string;
     description: string;
     header: string;
     password-label: string;
     reset-button: string;
     sub-header-end: string;
     sub-header-start: string;
     title: string;
  };
  @studiocms/dashboard:plugin-settings: {
     description: string;
     header: string;
     save-button: string;
     title: string;
  };
  @studiocms/dashboard:profile: {
     api-tokens-create: string;
     api-tokens-created: string;
     api-tokens-delete-button: string;
     api-tokens-description: string;
     api-tokens-header: string;
     api-tokens-modal-description: string;
     api-tokens-modal-header: string;
     api-tokens-modal-response-description: string;
     api-tokens-modal-response-header: string;
     api-tokens-no-tokens: string;
     basic-avatar-url: string;
     basic-info-display-name: string;
     basic-info-email: string;
     basic-info-header: string;
     basic-info-save-button: string;
     basic-info-username: string;
     basic-info-website: string;
     description: string;
     header: string;
     social-accounts-connected: string;
     social-accounts-header: string;
     social-accounts-no-connected: string;
     social-accounts-no-other: string;
     social-accounts-other: string;
     sync-with-libravatar: string;
     title: string;
     user-password-confirm: string;
     user-password-current: string;
     user-password-header: string;
     user-password-new: string;
     user-password-no-password: string;
     user-password-save-button: string;
  };
  @studiocms/dashboard:sidebar: {
     category-1-header: string;
     category-2-header: string;
     category-3-empty-placeholder: string;
     category-3-header: string;
     content-management-label: string;
     dashboard-link-label: string;
     mailer-configuration-label: string;
     site-configuration-label: string;
     user-dropdown:logout: string;
     user-dropdown:settings: string;
     user-dropdown:view-site: string;
     user-management-label: string;
  };
  @studiocms/dashboard:smtp: {
     description: string;
     emailVerification: string;
     header: string;
     oAuthBypassVerification: string;
     requireAdminVerification: string;
     requireEditorVerification: string;
     save-button: string;
     save-email-settings: string;
     send-test-email: string;
     site-email-settings: string;
     smtp-default-sender: string;
     smtp-default-sender-placeholder: string;
     smtp-host: string;
     smtp-host-placeholder: string;
     smtp-password: string;
     smtp-password-placeholder: string;
     smtp-port: string;
     smtp-port-placeholder: string;
     smtp-proxy: string;
     smtp-proxy-placeholder: string;
     smtp-secure: string;
     smtp-settings: string;
     smtp-tls-reject-unauthorized: string;
     smtp-tls-servername: string;
     smtp-tls-servername-placeholder: string;
     smtp-user: string;
     smtp-user-placeholder: string;
     test-email: string;
     test-email-placeholder: string;
     test-smtp: string;
     title: string;
  };
  @studiocms/dashboard:unverifiedEmail: {
     back-button: string;
     description: string;
     resend-button: string;
     sub-description: string;
     title: string;
  };
  @studiocms/dashboard:user-mngmt-edit: {
     api-tokens-created: string;
     api-tokens-delete-button: string;
     api-tokens-header: string;
     api-tokens-no-tokens: string;
     delete-modal-desc-1: string;
     delete-modal-desc-2: string;
     delete-modal-header: string;
     delete-modal-warning: string;
     description: string;
     edit-role-header: string;
     email-verification-status: string;
     header: string;
     header-delete-button: string;
     header-save-button: string;
     last-edit-pages-edited: string;
     last-edit-pages-header: string;
     last-edit-pages-no-edits: string;
     password-reset-button: string;
     password-reset-modal-desc-1: string;
     password-reset-modal-desc-2: string;
     password-reset-modal-header: string;
     password-reset-modal-link: string;
     social-accounts-header: string;
     social-accounts-non: string;
     title: string;
     user-info-created-at: string;
     user-info-email: string;
     user-info-header: string;
     user-info-updated-at: string;
     user-info-username: string;
     user-info-website: string;
  };
  @studiocms/dashboard:user-mngmt-index: {
     description: string;
     header: string;
     placeholder: string;
     title: string;
  };
  @studiocms/dashboard:user-mngmt-sidebar: {
     dropdown-create-invite: string;
     dropdown-create-user: string;
     input-placeholder-search: string;
  };
} = baseServerTranslations.translations;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:30^

The base translation object containing all translations for the default language.

Type Declaration

@studiocms/auth:login

@studiocms/auth:login: {
  allow-registration-noaccount: string;
  allow-registration-register: string;
  demo-mode-credentials: string;
  description: string;
  email-label: string;
  forgot-password: string;
  forgot-password-message: string;
  forgot-password-title: string;
  header: string;
  login-button: string;
  password-label: string;
  sub-header-noprovider: string;
  sub-header-oauth: string;
  sub-header-usernamepassword: string;
  sub-header-usernamepasswordoauth: string;
  title: string;
  username-label: string;
};

@studiocms/auth:login.allow-registration-noaccount

allow-registration-noaccount: string = "Don't have an account?";

@studiocms/auth:login.allow-registration-register

allow-registration-register: string = "Register here!";

@studiocms/auth:login.demo-mode-credentials

demo-mode-credentials: string = "Demo Mode Credentials";

@studiocms/auth:login.description

description: string = "Login Page";

@studiocms/auth:login.email-label

email-label: string = "Email Address";

@studiocms/auth:login.forgot-password

forgot-password: string = "Forgot Password? Click here.";

@studiocms/auth:login.forgot-password-message

forgot-password-message: string = "Forgot your password? Enter your email below and we'll send you a reset link.";

@studiocms/auth:login.forgot-password-title

forgot-password-title: string = "Forgot Password";

@studiocms/auth:login.header

header: string = "Login";

@studiocms/auth:login.login-button

login-button: string = "Log In";

@studiocms/auth:login.password-label

password-label: string = "Password";

@studiocms/auth:login.sub-header-noprovider

sub-header-noprovider: string = "No Login provider configured. Please contact your administrator.";

@studiocms/auth:login.sub-header-oauth

sub-header-oauth: string = "Log in using one of the options below.";

@studiocms/auth:login.sub-header-usernamepassword

sub-header-usernamepassword: string = "Enter your username & password.";

@studiocms/auth:login.sub-header-usernamepasswordoauth

sub-header-usernamepasswordoauth: string = "Enter your username & password or log in using one of the options below.";

@studiocms/auth:login.title

title: string = "Login Page";

@studiocms/auth:login.username-label

username-label: string = "Username";

@studiocms/auth:logout

@studiocms/auth:logout: {
  description: string;
  title: string;
};

@studiocms/auth:logout.description

description: string = "Logout Page";

@studiocms/auth:logout.title

title: string = "Logout Page";

@studiocms/auth:oauth-stack

@studiocms/auth:oauth-stack: {
  or-login-with: string;
};

@studiocms/auth:oauth-stack.or-login-with

or-login-with: string = "or log in using";

@studiocms/auth:signup

@studiocms/auth:signup: {
  allow-login-haveaccount: string;
  allow-login-login: string;
  confirm-password-label: string;
  create-account-button: string;
  description: string;
  displayname-label: string;
  email-label: string;
  header: string;
  password-label: string;
  sub-header-noprovider: string;
  sub-header-oauth: string;
  sub-header-usernamepassword: string;
  sub-header-usernamepasswordoauth: string;
  title: string;
  username-label: string;
};

@studiocms/auth:signup.allow-login-haveaccount

allow-login-haveaccount: string = "Already have an account?";

@studiocms/auth:signup.allow-login-login

allow-login-login: string = "Login here!";

@studiocms/auth:signup.confirm-password-label

confirm-password-label: string = "Confirm Password";

@studiocms/auth:signup.create-account-button

create-account-button: string = "Create Account";

@studiocms/auth:signup.description

description: string = "Sign Up Page";

@studiocms/auth:signup.displayname-label

displayname-label: string = "Display Name";

@studiocms/auth:signup.email-label

email-label: string = "Email";

@studiocms/auth:signup.header

header: string = "Sign Up";

@studiocms/auth:signup.password-label

password-label: string = "Password";

@studiocms/auth:signup.sub-header-noprovider

sub-header-noprovider: string = "No Login provider configured. Please contact your administrator.";

@studiocms/auth:signup.sub-header-oauth

sub-header-oauth: string = "Log in using one of the options below.";

@studiocms/auth:signup.sub-header-usernamepassword

sub-header-usernamepassword: string = "Create an account using the form below.";

@studiocms/auth:signup.sub-header-usernamepasswordoauth

sub-header-usernamepasswordoauth: string = "Create an account or log in using one of the options below.";

@studiocms/auth:signup.title

title: string = "Sign Up Page";

@studiocms/auth:signup.username-label

username-label: string = "Username";

@studiocms/dashboard:404

@studiocms/dashboard:404: {
  back-button: string;
  description: string;
  sub-description: string;
  title: string;
};

@studiocms/dashboard:404.back-button

back-button: string = "Go back";

@studiocms/dashboard:404.description

description: string = "Error 404 - Page Not Found";

@studiocms/dashboard:404.sub-description

sub-description: string = "The page you are looking for might have been removed, had its name changed or is temporarily unavailable.";

@studiocms/dashboard:404.title

title: string = "Error 404";

@studiocms/dashboard:configuration

@studiocms/dashboard:configuration: {
  dashboard-grid-label: string;
  description: string;
  header: string;
  input-custom-login-page: string;
  input-diff-tracking-limit: string;
  input-og-image: string;
  input-site-description: string;
  input-site-icon: string;
  input-site-title: string;
  login-page-preview: string;
  save-button: string;
  select-hide-default-index: string;
  select-login-page-bg: string;
  select-page-diff-tracking: string;
  select-smtp-mailer: string;
  title: string;
};

@studiocms/dashboard:configuration.dashboard-grid-label

dashboard-grid-label: string = "Dashboard Grid Items";

@studiocms/dashboard:configuration.description

description: string = "Configuration";

@studiocms/dashboard:configuration.header

header: string = "Site Configuration";

@studiocms/dashboard:configuration.input-custom-login-page

input-custom-login-page: string = "Login Page Background Image (Custom)";

@studiocms/dashboard:configuration.input-diff-tracking-limit

input-diff-tracking-limit: string = "Diff Tracking Limit (per page)";

@studiocms/dashboard:configuration.input-og-image

input-og-image: string = "Default Open Graph Image";

@studiocms/dashboard:configuration.input-site-description

input-site-description: string = "Site Description";

@studiocms/dashboard:configuration.input-site-icon

input-site-icon: string = "Site Icon (Public Favicon)";

@studiocms/dashboard:configuration.input-site-title

input-site-title: string = "Site Title";

@studiocms/dashboard:configuration.login-page-preview

login-page-preview: string = "Login Page Preview (Dark/Light)";

@studiocms/dashboard:configuration.save-button

save-button: string = "Save";

@studiocms/dashboard:configuration.select-hide-default-index

select-hide-default-index: string = "Hide Index Page from dashboard";

@studiocms/dashboard:configuration.select-login-page-bg

select-login-page-bg: string = "Login Page Background Image";

@studiocms/dashboard:configuration.select-page-diff-tracking

select-page-diff-tracking: string = "Page Diff Tracking";

@studiocms/dashboard:configuration.select-smtp-mailer

select-smtp-mailer: string = "SMTP Mailer";

@studiocms/dashboard:configuration.title

title: string = "Configuration";

@studiocms/dashboard:content-diff

@studiocms/dashboard:content-diff: {
  edited-by: string;
  edited-on: string;
  no-metadata-changes: string;
  page-content: string;
  page-metadata: string;
  page-title: string;
  revert-all: string;
  revert-content: string;
  revert-metadata: string;
  view-page: string;
};

@studiocms/dashboard:content-diff.edited-by

edited-by: string = "Edited by";

@studiocms/dashboard:content-diff.edited-on

edited-on: string = "Edited on";

@studiocms/dashboard:content-diff.no-metadata-changes

no-metadata-changes: string = "No Metadata changes found";

@studiocms/dashboard:content-diff.page-content

page-content: string = "Page Content";

@studiocms/dashboard:content-diff.page-metadata

page-metadata: string = "Page Metadata";

@studiocms/dashboard:content-diff.page-title

page-title: string = "Page Title";

@studiocms/dashboard:content-diff.revert-all

revert-all: string = "Revert All";

@studiocms/dashboard:content-diff.revert-content

revert-content: string = "Revert Content";

@studiocms/dashboard:content-diff.revert-metadata

revert-metadata: string = "Revert MetaData";

@studiocms/dashboard:content-diff.view-page

view-page: string = "View Page";

@studiocms/dashboard:content-folder

@studiocms/dashboard:content-folder: {
  input-folder-name: string;
  input-folder-parent: string;
};

@studiocms/dashboard:content-folder.input-folder-name

input-folder-name: string = "Folder Name";

@studiocms/dashboard:content-folder.input-folder-parent

input-folder-parent: string = "Parent Folder";

@studiocms/dashboard:content-header

@studiocms/dashboard:content-header: {
  create-button: string;
  create-folder-title: string;
  create-page-title: string;
  delete-button: string;
  delete-folder-modal-desc-1: string;
  delete-folder-modal-desc-2: string;
  delete-modal-desc-1: string;
  delete-modal-desc-2: string;
  delete-modal-header: string;
  delete-modal-warning: string;
  draft-button: string;
  edit-folder-title: string;
  edit-page-title: string;
  publish-button: string;
  save-button: string;
  title: string;
};

@studiocms/dashboard:content-header.create-button

create-button: string = "Create";

@studiocms/dashboard:content-header.create-folder-title

create-folder-title: string = "Create Folder";

@studiocms/dashboard:content-header.create-page-title

create-page-title: string = "Create Page";

@studiocms/dashboard:content-header.delete-button

delete-button: string = "Delete";

@studiocms/dashboard:content-header.delete-folder-modal-desc-1

delete-folder-modal-desc-1: string = "Enter the folder name";

@studiocms/dashboard:content-header.delete-folder-modal-desc-2

delete-folder-modal-desc-2: string = "to confirm.";

@studiocms/dashboard:content-header.delete-modal-desc-1

delete-modal-desc-1: string = "Enter the slug";

@studiocms/dashboard:content-header.delete-modal-desc-2

delete-modal-desc-2: string = "to confirm.";

@studiocms/dashboard:content-header.delete-modal-header

delete-modal-header: string = "Are you sure you want to delete this item?";

@studiocms/dashboard:content-header.delete-modal-warning

delete-modal-warning: string = "This action cannot be undone.";

@studiocms/dashboard:content-header.draft-button

draft-button: string = "Save Draft";

@studiocms/dashboard:content-header.edit-folder-title

edit-folder-title: string = "Edit Folder";

@studiocms/dashboard:content-header.edit-page-title

edit-page-title: string = "Edit Page";

@studiocms/dashboard:content-header.publish-button

publish-button: string = "Publish";

@studiocms/dashboard:content-header.save-button

save-button: string = "Save Changes";

@studiocms/dashboard:content-header.title

title: string = "Content Management";

@studiocms/dashboard:content-index

@studiocms/dashboard:content-index: {
  description: string;
  header: string;
  placeholder: string;
  title: string;
};

@studiocms/dashboard:content-index.description

description: string = "Content Management";

@studiocms/dashboard:content-index.header

header: string = "Content Management";

@studiocms/dashboard:content-index.placeholder

placeholder: string = "Select or Create a page to get started.";

@studiocms/dashboard:content-index.title

title: string = "Content Management";

@studiocms/dashboard:content-page

@studiocms/dashboard:content-page: {
  custom-page-type-fields-header: string;
  custom-page-types-description-new: string;
  diff-edited-by-1: string;
  diff-edited-by-2: string;
  diff-no-history: string;
  input-page-description: string;
  input-page-hero-image: string;
  input-page-slug: string;
  input-page-title: string;
  select-page-categories: string;
  select-page-draft: string;
  select-page-parent-folder: string;
  select-page-show-author: string;
  select-page-show-contributors: string;
  select-page-show-in-nav: string;
  select-page-tags: string;
  select-page-type: string;
  tab-label-basic-info: string;
  tab-label-content: string;
  tab-label-diff: string;
};

@studiocms/dashboard:content-page.custom-page-type-fields-header

custom-page-type-fields-header: string = "Custom Page Type Fields";

@studiocms/dashboard:content-page.custom-page-types-description-new

custom-page-types-description-new: string = "You have changed your pageType. Please save your changes and refresh the page to see the new fields.";

@studiocms/dashboard:content-page.diff-edited-by-1

diff-edited-by-1: string = "Edited";

@studiocms/dashboard:content-page.diff-edited-by-2

diff-edited-by-2: string = "by";

@studiocms/dashboard:content-page.diff-no-history

diff-no-history: string = "No history found.";

@studiocms/dashboard:content-page.input-page-description

input-page-description: string = "Description";

@studiocms/dashboard:content-page.input-page-hero-image

input-page-hero-image: string = "OpenGraph/Hero Image";

@studiocms/dashboard:content-page.input-page-slug

input-page-slug: string = "Slug";

@studiocms/dashboard:content-page.input-page-title

input-page-title: string = "Page Title";

@studiocms/dashboard:content-page.select-page-categories

select-page-categories: string = "Categories";

@studiocms/dashboard:content-page.select-page-draft

select-page-draft: string = "Draft";

@studiocms/dashboard:content-page.select-page-parent-folder

select-page-parent-folder: string = "Parent Folder";

@studiocms/dashboard:content-page.select-page-show-author

select-page-show-author: string = "Show Author";

@studiocms/dashboard:content-page.select-page-show-contributors

select-page-show-contributors: string = "Show Contributors";

@studiocms/dashboard:content-page.select-page-show-in-nav

select-page-show-in-nav: string = "Show in Navigation";

@studiocms/dashboard:content-page.select-page-tags

select-page-tags: string = "Tags";

@studiocms/dashboard:content-page.select-page-type

select-page-type: string = "Page Type";

@studiocms/dashboard:content-page.tab-label-basic-info

tab-label-basic-info: string = "Basic Information";

@studiocms/dashboard:content-page.tab-label-content

tab-label-content: string = "Page Content";

@studiocms/dashboard:content-page.tab-label-diff

tab-label-diff: string = "Edit History";

@studiocms/dashboard:content-sidebar

@studiocms/dashboard:content-sidebar: {
  dropdown-create-folder: string;
  dropdown-create-page: string;
  input-placeholder-search: string;
  items-divider: string;
};

@studiocms/dashboard:content-sidebar.dropdown-create-folder

dropdown-create-folder: string = "Create Folder";

@studiocms/dashboard:content-sidebar.dropdown-create-page

dropdown-create-page: string = "Create Page";

@studiocms/dashboard:content-sidebar.input-placeholder-search

input-placeholder-search: string = "Search...";

@studiocms/dashboard:content-sidebar.items-divider

items-divider: string = "Items";

@studiocms/dashboard:index

@studiocms/dashboard:index: {
  description: string;
  sub-header: string;
  title: string;
  title-button:discord: string;
  title-button:feedback: string;
  welcome-title: string;
};

@studiocms/dashboard:index.description

description: string = "Dashboard";

@studiocms/dashboard:index.sub-header

sub-header: string = "StudioCMS is a free and open-source content management system built from the ground up by the Astro community.";

@studiocms/dashboard:index.title

title: string = "Dashboard";

@studiocms/dashboard:index.title-button:discord

title-button:discord: string = "Join the Community";

@studiocms/dashboard:index.title-button:feedback

title-button:feedback: string = "Give Feedback";

@studiocms/dashboard:index.welcome-title

welcome-title: string = "Welcome";

@studiocms/dashboard:password-reset

@studiocms/dashboard:password-reset: {
  confirm-password-label: string;
  description: string;
  header: string;
  password-label: string;
  reset-button: string;
  sub-header-end: string;
  sub-header-start: string;
  title: string;
};

@studiocms/dashboard:password-reset.confirm-password-label

confirm-password-label: string = "Confirm Password";

@studiocms/dashboard:password-reset.description

description: string = "Password Reset";

@studiocms/dashboard:password-reset.header

header: string = "Password Reset";

@studiocms/dashboard:password-reset.password-label

password-label: string = "Password";

@studiocms/dashboard:password-reset.reset-button

reset-button: string = "Reset Password";

@studiocms/dashboard:password-reset.sub-header-end

sub-header-end: string = "Please enter your new password below.";

@studiocms/dashboard:password-reset.sub-header-start

sub-header-start: string = "Hello";

@studiocms/dashboard:password-reset.title

title: string = "Password Reset";

@studiocms/dashboard:plugin-settings

@studiocms/dashboard:plugin-settings: {
  description: string;
  header: string;
  save-button: string;
  title: string;
};

@studiocms/dashboard:plugin-settings.description

description: string = "Plugin Settings";

@studiocms/dashboard:plugin-settings.header

header: string = "Settings";

@studiocms/dashboard:plugin-settings.save-button

save-button: string = "Save Changes";

@studiocms/dashboard:plugin-settings.title

title: string = "Plugin Settings";

@studiocms/dashboard:profile

@studiocms/dashboard:profile: {
  api-tokens-create: string;
  api-tokens-created: string;
  api-tokens-delete-button: string;
  api-tokens-description: string;
  api-tokens-header: string;
  api-tokens-modal-description: string;
  api-tokens-modal-header: string;
  api-tokens-modal-response-description: string;
  api-tokens-modal-response-header: string;
  api-tokens-no-tokens: string;
  basic-avatar-url: string;
  basic-info-display-name: string;
  basic-info-email: string;
  basic-info-header: string;
  basic-info-save-button: string;
  basic-info-username: string;
  basic-info-website: string;
  description: string;
  header: string;
  social-accounts-connected: string;
  social-accounts-header: string;
  social-accounts-no-connected: string;
  social-accounts-no-other: string;
  social-accounts-other: string;
  sync-with-libravatar: string;
  title: string;
  user-password-confirm: string;
  user-password-current: string;
  user-password-header: string;
  user-password-new: string;
  user-password-no-password: string;
  user-password-save-button: string;
};

@studiocms/dashboard:profile.api-tokens-create

api-tokens-create: string = "Create API Token";

@studiocms/dashboard:profile.api-tokens-created

api-tokens-created: string = "Created";

@studiocms/dashboard:profile.api-tokens-delete-button

api-tokens-delete-button: string = "Delete";

@studiocms/dashboard:profile.api-tokens-description

api-tokens-description: string = "API tokens are used to authenticate with the StudioCMS REST API.";

@studiocms/dashboard:profile.api-tokens-header

api-tokens-header: string = "API Tokens";

@studiocms/dashboard:profile.api-tokens-modal-description

api-tokens-modal-description: string = "Description";

@studiocms/dashboard:profile.api-tokens-modal-header

api-tokens-modal-header: string = "Create New API Token";

@studiocms/dashboard:profile.api-tokens-modal-response-description

api-tokens-modal-response-description: string = "Please copy your new token. It will not be shown again.";

@studiocms/dashboard:profile.api-tokens-modal-response-header

api-tokens-modal-response-header: string = "New Token";

@studiocms/dashboard:profile.api-tokens-no-tokens

api-tokens-no-tokens: string = "No API tokens found.";

@studiocms/dashboard:profile.basic-avatar-url

basic-avatar-url: string = "Avatar URL";

@studiocms/dashboard:profile.basic-info-display-name

basic-info-display-name: string = "Display Name";

@studiocms/dashboard:profile.basic-info-email

basic-info-email: string = "Email";

@studiocms/dashboard:profile.basic-info-header

basic-info-header: string = "Basic Information";

@studiocms/dashboard:profile.basic-info-save-button

basic-info-save-button: string = "Save";

@studiocms/dashboard:profile.basic-info-username

basic-info-username: string = "Username";

@studiocms/dashboard:profile.basic-info-website

basic-info-website: string = "Website";

@studiocms/dashboard:profile.description

description: string = "User Profile";

@studiocms/dashboard:profile.header

header: string = "Your Profile";

@studiocms/dashboard:profile.social-accounts-connected

social-accounts-connected: string = "Connected Accounts";

@studiocms/dashboard:profile.social-accounts-header

social-accounts-header: string = "Social Sign-in Accounts";

@studiocms/dashboard:profile.social-accounts-no-connected

social-accounts-no-connected: string = "No connected accounts found.";

@studiocms/dashboard:profile.social-accounts-no-other

social-accounts-no-other: string = "No other sign-in options found.";

@studiocms/dashboard:profile.social-accounts-other

social-accounts-other: string = "Other Sign-In Options";

@studiocms/dashboard:profile.sync-with-libravatar

sync-with-libravatar: string = "Sync Libravatar";

@studiocms/dashboard:profile.title

title: string = "User Profile";

@studiocms/dashboard:profile.user-password-confirm

user-password-confirm: string = "Confirm New Password";

@studiocms/dashboard:profile.user-password-current

user-password-current: string = "Current Password";

@studiocms/dashboard:profile.user-password-header

user-password-header: string = "Create or Update Password";

@studiocms/dashboard:profile.user-password-new

user-password-new: string = "New Password";

@studiocms/dashboard:profile.user-password-no-password

user-password-no-password: string = "It looks like your account doesn't have a password set. You can set one by using the form below.";

@studiocms/dashboard:profile.user-password-save-button

user-password-save-button: string = "Save";

@studiocms/dashboard:sidebar

@studiocms/dashboard:sidebar: {
  category-1-header: string;
  category-2-header: string;
  category-3-empty-placeholder: string;
  category-3-header: string;
  content-management-label: string;
  dashboard-link-label: string;
  mailer-configuration-label: string;
  site-configuration-label: string;
  user-dropdown:logout: string;
  user-dropdown:settings: string;
  user-dropdown:view-site: string;
  user-management-label: string;
};

@studiocms/dashboard:sidebar.category-1-header

category-1-header: string = "Dashboard";

@studiocms/dashboard:sidebar.category-2-header

category-2-header: string = "Admin";

@studiocms/dashboard:sidebar.category-3-empty-placeholder

category-3-empty-placeholder: string = "No plugins with settings pages found.";

@studiocms/dashboard:sidebar.category-3-header

category-3-header: string = "Plugins";

@studiocms/dashboard:sidebar.content-management-label

content-management-label: string = "Content Management";

@studiocms/dashboard:sidebar.dashboard-link-label

dashboard-link-label: string = "Dashboard";

@studiocms/dashboard:sidebar.mailer-configuration-label

mailer-configuration-label: string = "SMTP Configuration";

@studiocms/dashboard:sidebar.site-configuration-label

site-configuration-label: string = "Site Configuration";

@studiocms/dashboard:sidebar.user-dropdown:logout

user-dropdown:logout: string = "Log Out";

@studiocms/dashboard:sidebar.user-dropdown:settings

user-dropdown:settings: string = "User Settings";

@studiocms/dashboard:sidebar.user-dropdown:view-site

user-dropdown:view-site: string = "View Site";

@studiocms/dashboard:sidebar.user-management-label

user-management-label: string = "User Management";

@studiocms/dashboard:smtp

@studiocms/dashboard:smtp: {
  description: string;
  emailVerification: string;
  header: string;
  oAuthBypassVerification: string;
  requireAdminVerification: string;
  requireEditorVerification: string;
  save-button: string;
  save-email-settings: string;
  send-test-email: string;
  site-email-settings: string;
  smtp-default-sender: string;
  smtp-default-sender-placeholder: string;
  smtp-host: string;
  smtp-host-placeholder: string;
  smtp-password: string;
  smtp-password-placeholder: string;
  smtp-port: string;
  smtp-port-placeholder: string;
  smtp-proxy: string;
  smtp-proxy-placeholder: string;
  smtp-secure: string;
  smtp-settings: string;
  smtp-tls-reject-unauthorized: string;
  smtp-tls-servername: string;
  smtp-tls-servername-placeholder: string;
  smtp-user: string;
  smtp-user-placeholder: string;
  test-email: string;
  test-email-placeholder: string;
  test-smtp: string;
  title: string;
};

@studiocms/dashboard:smtp.description

description: string = "SMTP Configuration";

@studiocms/dashboard:smtp.emailVerification

emailVerification: string = "Enable Email Verification for Users";

@studiocms/dashboard:smtp.header

header: string = "SMTP Configuration";

@studiocms/dashboard:smtp.oAuthBypassVerification

oAuthBypassVerification: string = "Skip Email Verification for OAuth Users";

@studiocms/dashboard:smtp.requireAdminVerification

requireAdminVerification: string = "Require Admins to have their email verified";

@studiocms/dashboard:smtp.requireEditorVerification

requireEditorVerification: string = "Require Editors to have their email verified";

@studiocms/dashboard:smtp.save-button

save-button: string = "Save";

@studiocms/dashboard:smtp.save-email-settings

save-email-settings: string = "Save";

@studiocms/dashboard:smtp.send-test-email

send-test-email: string = "Send Test Email";

@studiocms/dashboard:smtp.site-email-settings

site-email-settings: string = "Site Email Settings";

@studiocms/dashboard:smtp.smtp-default-sender

smtp-default-sender: string = "Default Sender";

@studiocms/dashboard:smtp.smtp-default-sender-placeholder

smtp-default-sender-placeholder: string = "StudioCMS no-reply <no-reply@example.com>";

@studiocms/dashboard:smtp.smtp-host

smtp-host: string = "Host";

@studiocms/dashboard:smtp.smtp-host-placeholder

smtp-host-placeholder: string = "smtp.example.com / 1.1.1.1";

@studiocms/dashboard:smtp.smtp-password

smtp-password: string = "Auth Password";

@studiocms/dashboard:smtp.smtp-password-placeholder

smtp-password-placeholder: string = "********";

@studiocms/dashboard:smtp.smtp-port

smtp-port: string = "Port";

@studiocms/dashboard:smtp.smtp-port-placeholder

smtp-port-placeholder: string = "587";

@studiocms/dashboard:smtp.smtp-proxy

smtp-proxy: string = "Proxy";

@studiocms/dashboard:smtp.smtp-proxy-placeholder

smtp-proxy-placeholder: string = "http://proxy.example.com";

@studiocms/dashboard:smtp.smtp-secure

smtp-secure: string = "Secure";

@studiocms/dashboard:smtp.smtp-settings

smtp-settings: string = "SMTP Settings";

@studiocms/dashboard:smtp.smtp-tls-reject-unauthorized

smtp-tls-reject-unauthorized: string = "TLS Reject Unauthorized";

@studiocms/dashboard:smtp.smtp-tls-servername

smtp-tls-servername: string = "TLS Servername";

@studiocms/dashboard:smtp.smtp-tls-servername-placeholder

smtp-tls-servername-placeholder: string = "smtp.example.com";

@studiocms/dashboard:smtp.smtp-user

smtp-user: string = "Auth Username";

@studiocms/dashboard:smtp.smtp-user-placeholder

smtp-user-placeholder: string = "no-reply@example.com";

@studiocms/dashboard:smtp.test-email

test-email: string = "Email Address";

@studiocms/dashboard:smtp.test-email-placeholder

test-email-placeholder: string = "john@example.com";

@studiocms/dashboard:smtp.test-smtp

test-smtp: string = "Send Test Email";

@studiocms/dashboard:smtp.title

title: string = "SMTP Configuration";

@studiocms/dashboard:unverifiedEmail

@studiocms/dashboard:unverifiedEmail: {
  back-button: string;
  description: string;
  resend-button: string;
  sub-description: string;
  title: string;
};

@studiocms/dashboard:unverifiedEmail.back-button

back-button: string = "Go home";

@studiocms/dashboard:unverifiedEmail.description

description: string = "Email Not Verified";

@studiocms/dashboard:unverifiedEmail.resend-button

resend-button: string = "Resend Verification Email";

@studiocms/dashboard:unverifiedEmail.sub-description

sub-description: string = "Your email address has not been verified. Please check your email for a verification link.";

@studiocms/dashboard:unverifiedEmail.title

title: string = "Email Not Verified";

@studiocms/dashboard:user-mngmt-edit

@studiocms/dashboard:user-mngmt-edit: {
  api-tokens-created: string;
  api-tokens-delete-button: string;
  api-tokens-header: string;
  api-tokens-no-tokens: string;
  delete-modal-desc-1: string;
  delete-modal-desc-2: string;
  delete-modal-header: string;
  delete-modal-warning: string;
  description: string;
  edit-role-header: string;
  email-verification-status: string;
  header: string;
  header-delete-button: string;
  header-save-button: string;
  last-edit-pages-edited: string;
  last-edit-pages-header: string;
  last-edit-pages-no-edits: string;
  password-reset-button: string;
  password-reset-modal-desc-1: string;
  password-reset-modal-desc-2: string;
  password-reset-modal-header: string;
  password-reset-modal-link: string;
  social-accounts-header: string;
  social-accounts-non: string;
  title: string;
  user-info-created-at: string;
  user-info-email: string;
  user-info-header: string;
  user-info-updated-at: string;
  user-info-username: string;
  user-info-website: string;
};

@studiocms/dashboard:user-mngmt-edit.api-tokens-created

api-tokens-created: string = "Created";

@studiocms/dashboard:user-mngmt-edit.api-tokens-delete-button

api-tokens-delete-button: string = "Delete";

@studiocms/dashboard:user-mngmt-edit.api-tokens-header

api-tokens-header: string = "API Tokens";

@studiocms/dashboard:user-mngmt-edit.api-tokens-no-tokens

api-tokens-no-tokens: string = "No API tokens found.";

@studiocms/dashboard:user-mngmt-edit.delete-modal-desc-1

delete-modal-desc-1: string = "Enter the user name";

@studiocms/dashboard:user-mngmt-edit.delete-modal-desc-2

delete-modal-desc-2: string = "to confirm.";

@studiocms/dashboard:user-mngmt-edit.delete-modal-header

delete-modal-header: string = "Are you sure you want to delete this user?";

@studiocms/dashboard:user-mngmt-edit.delete-modal-warning

delete-modal-warning: string = "This action cannot be undone.";

@studiocms/dashboard:user-mngmt-edit.description

description: string = "User Management";

@studiocms/dashboard:user-mngmt-edit.edit-role-header

edit-role-header: string = "User Role";

@studiocms/dashboard:user-mngmt-edit.email-verification-status

email-verification-status: string = "Email Verification Status";

@studiocms/dashboard:user-mngmt-edit.header

header: string = "User Management";

@studiocms/dashboard:user-mngmt-edit.header-delete-button

header-delete-button: string = "Delete";

@studiocms/dashboard:user-mngmt-edit.header-save-button

header-save-button: string = "Save Changes";

@studiocms/dashboard:user-mngmt-edit.last-edit-pages-edited

last-edit-pages-edited: string = "Edited";

@studiocms/dashboard:user-mngmt-edit.last-edit-pages-header

last-edit-pages-header: string = "Last Edited Pages";

@studiocms/dashboard:user-mngmt-edit.last-edit-pages-no-edits

last-edit-pages-no-edits: string = "No history found.";

@studiocms/dashboard:user-mngmt-edit.password-reset-button

password-reset-button: string = "Create Reset link";

@studiocms/dashboard:user-mngmt-edit.password-reset-modal-desc-1

password-reset-modal-desc-1: string = "Reset link for user";

@studiocms/dashboard:user-mngmt-edit.password-reset-modal-desc-2

password-reset-modal-desc-2: string = "has been created.";

@studiocms/dashboard:user-mngmt-edit.password-reset-modal-header

password-reset-modal-header: string = "Reset Password Link";

@studiocms/dashboard:user-mngmt-edit.password-reset-modal-link

password-reset-modal-link: string = "Link";

@studiocms/dashboard:user-mngmt-edit.social-accounts-header

social-accounts-header: string = "Connected Accounts";

@studiocms/dashboard:user-mngmt-edit.social-accounts-non

social-accounts-non: string = "No connected accounts found.";

@studiocms/dashboard:user-mngmt-edit.title

title: string = "User Management";

@studiocms/dashboard:user-mngmt-edit.user-info-created-at

user-info-created-at: string = "Created At";

@studiocms/dashboard:user-mngmt-edit.user-info-email

user-info-email: string = "Email";

@studiocms/dashboard:user-mngmt-edit.user-info-header

user-info-header: string = "User Information";

@studiocms/dashboard:user-mngmt-edit.user-info-updated-at

user-info-updated-at: string = "Updated At";

@studiocms/dashboard:user-mngmt-edit.user-info-username

user-info-username: string = "Username";

@studiocms/dashboard:user-mngmt-edit.user-info-website

user-info-website: string = "Website";

@studiocms/dashboard:user-mngmt-index

@studiocms/dashboard:user-mngmt-index: {
  description: string;
  header: string;
  placeholder: string;
  title: string;
};

@studiocms/dashboard:user-mngmt-index.description

description: string = "User Management";

@studiocms/dashboard:user-mngmt-index.header

header: string = "User Management";

@studiocms/dashboard:user-mngmt-index.placeholder

placeholder: string = "Select or Create a user to get started.";

@studiocms/dashboard:user-mngmt-index.title

title: string = "User Management";

@studiocms/dashboard:user-mngmt-sidebar

@studiocms/dashboard:user-mngmt-sidebar: {
  dropdown-create-invite: string;
  dropdown-create-user: string;
  input-placeholder-search: string;
};

@studiocms/dashboard:user-mngmt-sidebar.dropdown-create-invite

dropdown-create-invite: string = "Create User Invite";

@studiocms/dashboard:user-mngmt-sidebar.dropdown-create-user

dropdown-create-user: string = "Create New User";

@studiocms/dashboard:user-mngmt-sidebar.input-placeholder-search

input-placeholder-search: string = "Search...";

---

format

const format: any;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:60^

A formatter function for the current locale.

Functions

documentUpdater()

function documentUpdater(comp: any, lang: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:96^

Updates the document’s title, meta description, and language attribute based on the provided component and language.

Parameters

comp

any

An object containing the title and description properties to update the document’s title and meta description.

lang

string

The language code to set as the value of the document’s lang attribute.

Returns

void

---

makeTranslation()

function makeTranslation<Body>(currentPage:
  | "@studiocms/auth:login"
  | "@studiocms/auth:signup"
  | "@studiocms/auth:logout"
  | "@studiocms/auth:oauth-stack"
  | "@studiocms/dashboard:index"
  | "@studiocms/dashboard:sidebar"
  | "@studiocms/dashboard:profile"
  | "@studiocms/dashboard:password-reset"
  | "@studiocms/dashboard:configuration"
  | "@studiocms/dashboard:smtp"
  | "@studiocms/dashboard:user-mngmt-sidebar"
  | "@studiocms/dashboard:user-mngmt-index"
  | "@studiocms/dashboard:user-mngmt-edit"
  | "@studiocms/dashboard:plugin-settings"
  | "@studiocms/dashboard:content-sidebar"
  | "@studiocms/dashboard:content-header"
  | "@studiocms/dashboard:content-index"
  | "@studiocms/dashboard:content-diff"
  | "@studiocms/dashboard:content-folder"
  | "@studiocms/dashboard:content-page"
  | "@studiocms/dashboard:404"
  | "@studiocms/dashboard:unverifiedEmail", i18n: Messages<Body>): typeof Translation;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:110^

Create a custom element that will update its text content when the translation changes.

Type Parameters

Body

Body extends Translations

Parameters

currentPage

"@studiocms/auth:login" | "@studiocms/auth:signup" | "@studiocms/auth:logout" | "@studiocms/auth:oauth-stack" | "@studiocms/dashboard:index" | "@studiocms/dashboard:sidebar" | "@studiocms/dashboard:profile" | "@studiocms/dashboard:password-reset" | "@studiocms/dashboard:configuration" | "@studiocms/dashboard:smtp" | "@studiocms/dashboard:user-mngmt-sidebar" | "@studiocms/dashboard:user-mngmt-index" | "@studiocms/dashboard:user-mngmt-edit" | "@studiocms/dashboard:plugin-settings" | "@studiocms/dashboard:content-sidebar" | "@studiocms/dashboard:content-header" | "@studiocms/dashboard:content-index" | "@studiocms/dashboard:content-diff" | "@studiocms/dashboard:content-folder" | "@studiocms/dashboard:content-page" | "@studiocms/dashboard:404" | "@studiocms/dashboard:unverifiedEmail"

i18n

Messages<Body>

Returns

typeof Translation

---

pageHeaderUpdater()

function pageHeaderUpdater(translation: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:229^

Updates the text content of the page header’s title element with the provided translation.

Parameters

translation

string

The translated string to set as the page title.

Returns

void

Remarks

This function selects the element with the class .page-header and then finds its child with the class .page-title, updating its text content to the given translation. It assumes that both elements exist in the DOM.

---

updateElmLabel()

function updateElmLabel(el: string, translation: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:144^

Updates the label text for a given form element with a translated string.

Searches for a <label> element associated with the specified element ID (el) and updates its child element with the class .label to display the provided translation. If the label’s inner HTML matches the requiredLabelRegex, it appends a required star indicator.

Parameters

el

string

The ID of the form element whose label should be updated.

translation

string

The translated string to set as the label’s text.

Returns

void

---

updateElmPlaceholder()

function updateElmPlaceholder(el: string, translation: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:168^

Updates the placeholder text of an input element with the specified ID.

Parameters

el

string

The ID of the input element whose placeholder should be updated.

translation

string

The new placeholder text to set for the input element.

Returns

void

Remarks

This function queries the DOM for an input element with the given ID and sets its placeholder property to the provided translation string.

Throws

If no element with the specified ID is found, or if the element is not an input.

---

updateSelectElmLabel()

function updateSelectElmLabel(el: string, translation: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:183^

Updates the label of a select element with a translated string.

Finds the corresponding <label> element for the given select element by its for attribute, and updates its content with the provided translation. If the label contains a required field indicator (as determined by requiredLabelRegex), it preserves the required star (*) in the label.

Parameters

el

string

The base ID of the select element (without the -select-btn suffix).

translation

string

The translated string to set as the label’s text.

Returns

void

---

updateToggleElmLabel()

function updateToggleElmLabel(el: string, translation: string): void;

Defined in: studiocms/packages/studiocms/src/virtuals/i18n/client.ts:207^

Updates the label text for a toggle element with a given translation.

This function locates the <label> element associated with the provided element ID (el), then finds the corresponding <span> inside the label with the ID label-${el}. If the span’s inner HTML matches the requiredLabelRegex, it updates the span’s inner HTML to include the translated text and a required star indicator. Otherwise, it simply updates the span’s text content with the translation.

Parameters

el

string

The ID of the element whose label should be updated.

translation

string

The translated text to set as the label.

Returns

void

References

defaultLang

Re-exports defaultLang

---

UiTranslationKey

Re-exports UiTranslationKey

---

uiTranslationsAvailable

Re-exports uiTranslationsAvailable