vuepress-theme-hope
Version:
A light vuepress theme with tons of features
115 lines (114 loc) • 2.32 kB
TypeScript
export interface EncryptLocaleData {
/**
* Aria label for encrypt icon
*
* 加密图标的无障碍标签
*/
iconLabel: string;
/**
* Password placeholder
*
* 密码输入框的默认占位符
*/
placeholder: string;
/**
* Whether remember password
*
* 是否记忆密码
*/
remember: string;
/**
* Password error hint
*
* 密码错误提示
*/
errorHint: string;
}
export type PasswordOptions = string | string[] | {
password: string | string[];
hint: string;
};
/**
* Encrypt Options
*
* 加密选项
*
* @kind root
*/
export interface EncryptOptions {
/**
* Whether encrypt globally
*
* 是否全局加密
*
* @default false
*/
global?: boolean;
/**
* Admin passwords, which has the highest authority
*
* 最高权限密码
*/
admin?: PasswordOptions;
/**
* Encrypt Configuration
*
* @example
* ({
* // This will encrypt the entire guide directory and both passwords will be available
* "/guide/": ["1234", "5678"],
* // this will only encrypt /config/page.html
* "/config/page.html": {
* password: "1234",
* hint: "This is a hint",
* },
* });
*
* 加密配置;
*
* @example
* ({
* // 这会加密整个 guide 目录，并且两个密码都是可用的
* "/guide/": ["1234", "5678"],
* // 这只会加密 /config/page.html
* "/config/page.html": {
* password: "1234",
* hint: "这是一个提示",
* },
* });
*/
config?: Record<string, PasswordOptions>;
}
export interface PasswordConfig {
tokens: string[];
hint?: string;
}
/**
* Encrypt Config
*
* 加密配置
*
* @kind root
*/
export interface EncryptConfig {
/**
* Whether encrypt globally
*
* 是否全局加密
*
* @default false
*/
global?: boolean;
/**
* Admin passwords, which has the highest authority
*
* 最高权限密码
*/
admin?: PasswordConfig;
/**
* Encrypt Configuration
*
* 加密配置
*/
config?: Record<string, PasswordConfig>;
}