Aller au contenu
StudioCMS Docs
Site principal

Paramètres régionaux

locale permet de définir des préférences spécifiques aux paramètres régionaux

studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    readonly dbStartPage?: boolean | undefined;
    readonly verbose?: boolean | undefined;
    readonly logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None" | undefined;
    readonly db?: {
        readonly dialect?: "libsql" | "postgres" | "mysql" | undefined;
    } | undefined;
    readonly plugins?: {
        readonly identifier: string;
        readonly name: string;
        readonly studiocmsMinimumVersion?: string | undefined;
        readonly requires?: readonly string[] | undefined;
        readonly hooks: {
            "studiocms:astro-config"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => void) | undefined;
            "studiocms:auth"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => void) | undefined;
            "studiocms:dashboard"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setDashboard: (args: {
                    translations: {
                        [x: string]: {
                            [x: string]: {
                                [x: string]: string;
                            };
                        };
                    };
                    dashboardGridItems?: readonly {
                        readonly name: string;
                        readonly span: 1 | 2 | 3;
                        readonly variant: "default" | "filled";
                        readonly requiresPermission?: "owner" | "admin" | "editor" | "visitor" | undefined;
                        readonly header?: {
                            readonly title: string;
                            readonly icon?: "heroicons:academic-cap" | "heroicons:academic-cap-16-solid" | "heroicons:academic-cap-20-solid" | "heroicons:academic-cap-solid" | "heroicons:adjustments-horizontal" | "heroicons:adjustments-horizontal-16-solid" | "heroicons:adjustments-horizontal-20-solid" | "heroicons:adjustments-horizontal-solid" | "heroicons:adjustments-vertical" | "heroicons:adjustments-vertical-16-solid" | "heroicons:adjustments-vertical-20-solid" | "heroicons:adjustments-vertical-solid" | "heroicons:archive-box" | "heroicons:archive-box-16-solid" | "heroicons:archive-box-20-solid" | "heroicons:archive-box-arrow-down" | "heroicons:archive-box-arrow-down-16-solid" | "heroicons:archive-box-arrow-down-20-solid" | "heroicons:archive-box-arrow-down-solid" | "heroicons:archive-box-solid" | "heroicons:archive-box-x-mark" | "heroicons:archive-box-x-mark-16-solid" | "heroicons:archive-box-x-mark-20-solid" | "heroicons:archive-box-x-mark-solid" | "heroicons:arrow-down" | "heroicons:arrow-down-16-solid" | "heroicons:arrow-down-20-solid" | "heroicons:arrow-down-circle" | "heroicons:arrow-down-circle-16-solid" | "heroicons:arrow-down-circle-20-solid" | "heroicons:arrow-down-circle-solid" | "heroicons:arrow-down-left" | "heroicons:arrow-down-left-16-solid" | "heroicons:arrow-down-left-20-solid" | "heroicons:arrow-down-left-solid" | "heroicons:arrow-down-on-square" | "heroicons:arrow-down-on-square-16-solid" | "heroicons:arrow-down-on-square-20-solid" | "heroicons:arrow-down-on-square-solid" | "heroicons:arrow-down-on-square-stack" | "heroicons:arrow-down-on-square-stack-16-solid" | "heroicons:arrow-down-on-square-stack-20-solid" | "heroicons:arrow-down-on-square-stack-solid" | "heroicons:arrow-down-right" | "heroicons:arrow-down-right-16-solid" | "heroicons:arrow-down-right-20-solid" | "heroicons:arrow-down-right-solid" | "heroicons:arrow-down-solid" | "heroicons:arrow-down-tray" | "heroicons:arrow-down-tray-16-solid" | "heroicons:arrow-down-tray-20-solid" | "heroicons:arrow-down-tray-solid" ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';


export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
locale?: {
    readonly dateLocale?: string | undefined;
    readonly dateTimeFormat?: {
        readonly localeMatcher?: "best fit" | "lookup" | undefined;
        readonly weekday?: "long" | "short" | "narrow" | undefined;
        readonly era?: "long" | "short" | "narrow" | undefined;
        readonly year?: "numeric" | "2-digit" | undefined;
        readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
        readonly day?: "numeric" | "2-digit" | undefined;
        readonly hour?: "numeric" | "2-digit" | undefined;
        readonly minute?: "numeric" | "2-digit" | undefined;
        readonly second?: "numeric" | "2-digit" | undefined;
        readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
        readonly formatMatcher?: "basic" | "best fit" | undefined;
        readonly hour12?: boolean | undefined;
        readonly timeZone?: string | undefined;
    } | undefined;
    readonly i18n?: {
        readonly defaultLocale?: string | undefined;
    } | undefined;
} | undefined
locale: {
    
dateLocale?: string | undefined
dateLocale: 'en-US',
    
dateTimeFormat?: {
    readonly localeMatcher?: "best fit" | "lookup" | undefined;
    readonly weekday?: "long" | "short" | "narrow" | undefined;
    readonly era?: "long" | "short" | "narrow" | undefined;
    readonly year?: "numeric" | "2-digit" | undefined;
    readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
    readonly day?: "numeric" | "2-digit" | undefined;
    readonly hour?: "numeric" | "2-digit" | undefined;
    readonly minute?: "numeric" | "2-digit" | undefined;
    readonly second?: "numeric" | "2-digit" | undefined;
    readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
    readonly formatMatcher?: "basic" | "best fit" | undefined;
    readonly hour12?: boolean | undefined;
    readonly timeZone?: string | undefined;
} | undefined
dateTimeFormat: {},
    
i18n?: {
    readonly defaultLocale?: string | undefined;
} | undefined
i18n: {}
  },
});

dateLocale

Section intitulée « dateLocale »

dateLocale est un identifiant de paramètres régionaux BCP 47 utilisé pour le formatage des dates.

  • Type : string
  • Par défaut : 'en-US'

Utilisation

Section intitulée « Utilisation »
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    readonly dbStartPage?: boolean | undefined;
    readonly verbose?: boolean | undefined;
    readonly logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None" | undefined;
    readonly db?: {
        readonly dialect?: "libsql" | "postgres" | "mysql" | undefined;
    } | undefined;
    readonly plugins?: {
        readonly identifier: string;
        readonly name: string;
        readonly studiocmsMinimumVersion?: string | undefined;
        readonly requires?: readonly string[] | undefined;
        readonly hooks: {
            "studiocms:astro-config"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => void) | undefined;
            "studiocms:auth"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => void) | undefined;
            "studiocms:dashboard"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setDashboard: (args: {
                    translations: {
                        [x: string]: {
                            [x: string]: {
                                [x: string]: string;
                            };
                        };
                    };
                    dashboardGridItems?: readonly {
                        readonly name: string;
                        readonly span: 1 | 2 | 3;
                        readonly variant: "default" | "filled";
                        readonly requiresPermission?: "owner" | "admin" | "editor" | "visitor" | undefined;
                        readonly header?: {
                            readonly title: string;
                            readonly icon?: "heroicons:academic-cap" | "heroicons:academic-cap-16-solid" | "heroicons:academic-cap-20-solid" | "heroicons:academic-cap-solid" | "heroicons:adjustments-horizontal" | "heroicons:adjustments-horizontal-16-solid" | "heroicons:adjustments-horizontal-20-solid" | "heroicons:adjustments-horizontal-solid" | "heroicons:adjustments-vertical" | "heroicons:adjustments-vertical-16-solid" | "heroicons:adjustments-vertical-20-solid" | "heroicons:adjustments-vertical-solid" | "heroicons:archive-box" | "heroicons:archive-box-16-solid" | "heroicons:archive-box-20-solid" | "heroicons:archive-box-arrow-down" | "heroicons:archive-box-arrow-down-16-solid" | "heroicons:archive-box-arrow-down-20-solid" | "heroicons:archive-box-arrow-down-solid" | "heroicons:archive-box-solid" | "heroicons:archive-box-x-mark" | "heroicons:archive-box-x-mark-16-solid" | "heroicons:archive-box-x-mark-20-solid" | "heroicons:archive-box-x-mark-solid" | "heroicons:arrow-down" | "heroicons:arrow-down-16-solid" | "heroicons:arrow-down-20-solid" | "heroicons:arrow-down-circle" | "heroicons:arrow-down-circle-16-solid" | "heroicons:arrow-down-circle-20-solid" | "heroicons:arrow-down-circle-solid" | "heroicons:arrow-down-left" | "heroicons:arrow-down-left-16-solid" | "heroicons:arrow-down-left-20-solid" | "heroicons:arrow-down-left-solid" | "heroicons:arrow-down-on-square" | "heroicons:arrow-down-on-square-16-solid" | "heroicons:arrow-down-on-square-20-solid" | "heroicons:arrow-down-on-square-solid" | "heroicons:arrow-down-on-square-stack" | "heroicons:arrow-down-on-square-stack-16-solid" | "heroicons:arrow-down-on-square-stack-20-solid" | "heroicons:arrow-down-on-square-stack-solid" | "heroicons:arrow-down-right" | "heroicons:arrow-down-right-16-solid" | "heroicons:arrow-down-right-20-solid" | "heroicons:arrow-down-right-solid" | "heroicons:arrow-down-solid" | "heroicons:arrow-down-tray" | "heroicons:arrow-down-tray-16-solid" | "heroicons:arrow-down-tray-20-solid" | "heroicons:arrow-down-tray-solid" ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';


export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
locale?: {
    readonly dateLocale?: string | undefined;
    readonly dateTimeFormat?: {
        readonly localeMatcher?: "best fit" | "lookup" | undefined;
        readonly weekday?: "long" | "short" | "narrow" | undefined;
        readonly era?: "long" | "short" | "narrow" | undefined;
        readonly year?: "numeric" | "2-digit" | undefined;
        readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
        readonly day?: "numeric" | "2-digit" | undefined;
        readonly hour?: "numeric" | "2-digit" | undefined;
        readonly minute?: "numeric" | "2-digit" | undefined;
        readonly second?: "numeric" | "2-digit" | undefined;
        readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
        readonly formatMatcher?: "basic" | "best fit" | undefined;
        readonly hour12?: boolean | undefined;
        readonly timeZone?: string | undefined;
    } | undefined;
    readonly i18n?: {
        readonly defaultLocale?: string | undefined;
    } | undefined;
} | undefined
locale: {
    
dateLocale?: string | undefined
dateLocale: 'en-US', // PAR DÉFAUT - Ceci définit les paramètres régionaux de date pour le formatage de la date.
  }
})

dateTimeFormat

Section intitulée « dateTimeFormat »

dateTimeFormat est un objet utilisé pour configurer le format de date et d’heure.

  • Type : Intl.DateTimeFormatOptions
  • Par défaut : {}

Utilisation

Section intitulée « Utilisation »
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    readonly dbStartPage?: boolean | undefined;
    readonly verbose?: boolean | undefined;
    readonly logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None" | undefined;
    readonly db?: {
        readonly dialect?: "libsql" | "postgres" | "mysql" | undefined;
    } | undefined;
    readonly plugins?: {
        readonly identifier: string;
        readonly name: string;
        readonly studiocmsMinimumVersion?: string | undefined;
        readonly requires?: readonly string[] | undefined;
        readonly hooks: {
            "studiocms:astro-config"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => void) | undefined;
            "studiocms:auth"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => void) | undefined;
            "studiocms:dashboard"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setDashboard: (args: {
                    translations: {
                        [x: string]: {
                            [x: string]: {
                                [x: string]: string;
                            };
                        };
                    };
                    dashboardGridItems?: readonly {
                        readonly name: string;
                        readonly span: 1 | 2 | 3;
                        readonly variant: "default" | "filled";
                        readonly requiresPermission?: "owner" | "admin" | "editor" | "visitor" | undefined;
                        readonly header?: {
                            readonly title: string;
                            readonly icon?: "heroicons:academic-cap" | "heroicons:academic-cap-16-solid" | "heroicons:academic-cap-20-solid" | "heroicons:academic-cap-solid" | "heroicons:adjustments-horizontal" | "heroicons:adjustments-horizontal-16-solid" | "heroicons:adjustments-horizontal-20-solid" | "heroicons:adjustments-horizontal-solid" | "heroicons:adjustments-vertical" | "heroicons:adjustments-vertical-16-solid" | "heroicons:adjustments-vertical-20-solid" | "heroicons:adjustments-vertical-solid" | "heroicons:archive-box" | "heroicons:archive-box-16-solid" | "heroicons:archive-box-20-solid" | "heroicons:archive-box-arrow-down" | "heroicons:archive-box-arrow-down-16-solid" | "heroicons:archive-box-arrow-down-20-solid" | "heroicons:archive-box-arrow-down-solid" | "heroicons:archive-box-solid" | "heroicons:archive-box-x-mark" | "heroicons:archive-box-x-mark-16-solid" | "heroicons:archive-box-x-mark-20-solid" | "heroicons:archive-box-x-mark-solid" | "heroicons:arrow-down" | "heroicons:arrow-down-16-solid" | "heroicons:arrow-down-20-solid" | "heroicons:arrow-down-circle" | "heroicons:arrow-down-circle-16-solid" | "heroicons:arrow-down-circle-20-solid" | "heroicons:arrow-down-circle-solid" | "heroicons:arrow-down-left" | "heroicons:arrow-down-left-16-solid" | "heroicons:arrow-down-left-20-solid" | "heroicons:arrow-down-left-solid" | "heroicons:arrow-down-on-square" | "heroicons:arrow-down-on-square-16-solid" | "heroicons:arrow-down-on-square-20-solid" | "heroicons:arrow-down-on-square-solid" | "heroicons:arrow-down-on-square-stack" | "heroicons:arrow-down-on-square-stack-16-solid" | "heroicons:arrow-down-on-square-stack-20-solid" | "heroicons:arrow-down-on-square-stack-solid" | "heroicons:arrow-down-right" | "heroicons:arrow-down-right-16-solid" | "heroicons:arrow-down-right-20-solid" | "heroicons:arrow-down-right-solid" | "heroicons:arrow-down-solid" | "heroicons:arrow-down-tray" | "heroicons:arrow-down-tray-16-solid" | "heroicons:arrow-down-tray-20-solid" | "heroicons:arrow-down-tray-solid" ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';


export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
locale?: {
    readonly dateLocale?: string | undefined;
    readonly dateTimeFormat?: {
        readonly localeMatcher?: "best fit" | "lookup" | undefined;
        readonly weekday?: "long" | "short" | "narrow" | undefined;
        readonly era?: "long" | "short" | "narrow" | undefined;
        readonly year?: "numeric" | "2-digit" | undefined;
        readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
        readonly day?: "numeric" | "2-digit" | undefined;
        readonly hour?: "numeric" | "2-digit" | undefined;
        readonly minute?: "numeric" | "2-digit" | undefined;
        readonly second?: "numeric" | "2-digit" | undefined;
        readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
        readonly formatMatcher?: "basic" | "best fit" | undefined;
        readonly hour12?: boolean | undefined;
        readonly timeZone?: string | undefined;
    } | undefined;
    readonly i18n?: {
        readonly defaultLocale?: string | undefined;
    } | undefined;
} | undefined
locale: {
    
dateTimeFormat?: {
    readonly localeMatcher?: "best fit" | "lookup" | undefined;
    readonly weekday?: "long" | "short" | "narrow" | undefined;
    readonly era?: "long" | "short" | "narrow" | undefined;
    readonly year?: "numeric" | "2-digit" | undefined;
    readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
    readonly day?: "numeric" | "2-digit" | undefined;
    readonly hour?: "numeric" | "2-digit" | undefined;
    readonly minute?: "numeric" | "2-digit" | undefined;
    readonly second?: "numeric" | "2-digit" | undefined;
    readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
    readonly formatMatcher?: "basic" | "best fit" | undefined;
    readonly hour12?: boolean | undefined;
    readonly timeZone?: string | undefined;
} | undefined
dateTimeFormat: {
      
year?: "numeric" | "2-digit" | undefined
year: "numeric",
      
month?: "numeric" | "2-digit" | "long" | "short" | "narrow" | undefined
month: "short",
      
day?: "numeric" | "2-digit" | undefined
day: "numeric"
    },
  }
})

i18n

Section intitulée « i18n »

i18n est un objet utilisé pour configurer les options d’internationalisation.

  • Type : object
  • Par défaut : {}

Utilisation

Section intitulée « Utilisation »
studiocms.config.mjs
export default 
function defineStudioCMSConfig(config: StudioCMSOptions): {
    readonly dbStartPage?: boolean | undefined;
    readonly verbose?: boolean | undefined;
    readonly logLevel?: "All" | "Fatal" | "Error" | "Warning" | "Info" | "Debug" | "Trace" | "None" | undefined;
    readonly db?: {
        readonly dialect?: "libsql" | "postgres" | "mysql" | undefined;
    } | undefined;
    readonly plugins?: {
        readonly identifier: string;
        readonly name: string;
        readonly studiocmsMinimumVersion?: string | undefined;
        readonly requires?: readonly string[] | undefined;
        readonly hooks: {
            "studiocms:astro-config"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly addIntegrations: (args: AstroIntegration | AstroIntegration[]) => Promise<void>;
            }) => void) | undefined;
            "studiocms:auth"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => Promise<void>) | ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setAuthService: (args: {
                    oAuthProvider: {
                        readonly name: string;
                        readonly formattedName: string;
                        readonly svg: string;
                        readonly endpointPath: string;
                        readonly requiredEnvVariables?: readonly string[] | undefined;
                    };
                }) => Promise<void>;
            }) => void) | undefined;
            "studiocms:dashboard"?: ((args: {
                readonly logger: AstroIntegrationLogger;
                readonly setDashboard: (args: {
                    translations: {
                        [x: string]: {
                            [x: string]: {
                                [x: string]: string;
                            };
                        };
                    };
                    dashboardGridItems?: readonly {
                        readonly name: string;
                        readonly span: 1 | 2 | 3;
                        readonly variant: "default" | "filled";
                        readonly requiresPermission?: "owner" | "admin" | "editor" | "visitor" | undefined;
                        readonly header?: {
                            readonly title: string;
                            readonly icon?: "heroicons:academic-cap" | "heroicons:academic-cap-16-solid" | "heroicons:academic-cap-20-solid" | "heroicons:academic-cap-solid" | "heroicons:adjustments-horizontal" | "heroicons:adjustments-horizontal-16-solid" | "heroicons:adjustments-horizontal-20-solid" | "heroicons:adjustments-horizontal-solid" | "heroicons:adjustments-vertical" | "heroicons:adjustments-vertical-16-solid" | "heroicons:adjustments-vertical-20-solid" | "heroicons:adjustments-vertical-solid" | "heroicons:archive-box" | "heroicons:archive-box-16-solid" | "heroicons:archive-box-20-solid" | "heroicons:archive-box-arrow-down" | "heroicons:archive-box-arrow-down-16-solid" | "heroicons:archive-box-arrow-down-20-solid" | "heroicons:archive-box-arrow-down-solid" | "heroicons:archive-box-solid" | "heroicons:archive-box-x-mark" | "heroicons:archive-box-x-mark-16-solid" | "heroicons:archive-box-x-mark-20-solid" | "heroicons:archive-box-x-mark-solid" | "heroicons:arrow-down" | "heroicons:arrow-down-16-solid" | "heroicons:arrow-down-20-solid" | "heroicons:arrow-down-circle" | "heroicons:arrow-down-circle-16-solid" | "heroicons:arrow-down-circle-20-solid" | "heroicons:arrow-down-circle-solid" | "heroicons:arrow-down-left" | "heroicons:arrow-down-left-16-solid" | "heroicons:arrow-down-left-20-solid" | "heroicons:arrow-down-left-solid" | "heroicons:arrow-down-on-square" | "heroicons:arrow-down-on-square-16-solid" | "heroicons:arrow-down-on-square-20-solid" | "heroicons:arrow-down-on-square-solid" | "heroicons:arrow-down-on-square-stack" | "heroicons:arrow-down-on-square-stack-16-solid" | "heroicons:arrow-down-on-square-stack-20-solid" | "heroicons:arrow-down-on-square-stack-solid" | "heroicons:arrow-down-right" | "heroicons:arrow-down-right-16-solid" | "heroicons:arrow-down-right-20-solid" | "heroicons:arrow-down-right-solid" | "heroicons:arrow-down-solid" | "heroicons:arrow-down-tray" | "heroicons:arrow-down-tray-16-solid" | "heroicons:arrow-down-tray-20-solid" | "heroicons:arrow-down-tray-solid" ...
A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.


StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.


Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
@example 
// studiocms.config.mjs
import { defineStudioCMSConfig } from 'studiocms/config';


export default defineStudioCMSConfig({
 dbStartPage: true,
 // ...Other Options
})
defineStudioCMSConfig({
  
locale?: {
    readonly dateLocale?: string | undefined;
    readonly dateTimeFormat?: {
        readonly localeMatcher?: "best fit" | "lookup" | undefined;
        readonly weekday?: "long" | "short" | "narrow" | undefined;
        readonly era?: "long" | "short" | "narrow" | undefined;
        readonly year?: "numeric" | "2-digit" | undefined;
        readonly month?: "long" | "short" | "narrow" | "numeric" | "2-digit" | undefined;
        readonly day?: "numeric" | "2-digit" | undefined;
        readonly hour?: "numeric" | "2-digit" | undefined;
        readonly minute?: "numeric" | "2-digit" | undefined;
        readonly second?: "numeric" | "2-digit" | undefined;
        readonly timeZoneName?: "long" | "short" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric" | undefined;
        readonly formatMatcher?: "basic" | "best fit" | undefined;
        readonly hour12?: boolean | undefined;
        readonly timeZone?: string | undefined;
    } | undefined;
    readonly i18n?: {
        readonly defaultLocale?: string | undefined;
    } | undefined;
} | undefined
locale: {
    
i18n?: {
    readonly defaultLocale?: string | undefined;
} | undefined
i18n: {
      
defaultLocale?: string | undefined
defaultLocale: 'en',
    },
  }
})