|
21 | 21 | "type": "Component<ThemeProps> | undefined", |
22 | 22 | "def": "`~icons/cmfx/loading`\n\n" |
23 | 23 | }, |
| 24 | + { |
| 25 | + "name": "schemes", |
| 26 | + "summary": "支持的主题列表\n\n", |
| 27 | + "remarks": "`schemes`\n下定义部分主题可以直接在此处使用。\n\n", |
| 28 | + "type": "Map<string, Scheme> | undefined", |
| 29 | + "def": "`new Map()`\n\n" |
| 30 | + }, |
| 31 | + { |
| 32 | + "name": "messages", |
| 33 | + "summary": "当前支持的语言列表以及加载方法\n\n", |
| 34 | + "type": "Record<string, DictLoader[]>" |
| 35 | + }, |
| 36 | + { |
| 37 | + "name": "title", |
| 38 | + "summary": "网站的标题\n\n", |
| 39 | + "remarks": "如果不为空,会和\n`titleSeparator`\n组成页面标题的后缀。\n\n", |
| 40 | + "type": "string" |
| 41 | + }, |
| 42 | + { |
| 43 | + "name": "titleSeparator", |
| 44 | + "summary": "网页标题的分隔符\n\n", |
| 45 | + "type": "string | undefined", |
| 46 | + "def": "' - '\n\n" |
| 47 | + }, |
| 48 | + { |
| 49 | + "name": "pageSizes", |
| 50 | + "summary": "分页符中页码选项的默认值\n\n", |
| 51 | + "type": "number[] | undefined", |
| 52 | + "def": "[10, 20, 50, 100]\n\n" |
| 53 | + }, |
| 54 | + { |
| 55 | + "name": "pageSize", |
| 56 | + "summary": "表格等需要分页对象的每页默认数量\n\n", |
| 57 | + "type": "number | undefined", |
| 58 | + "def": "20\n\n" |
| 59 | + }, |
| 60 | + { |
| 61 | + "name": "problemHandler", |
| 62 | + "summary": "对\n`Problem`\n的处理函数\n\n", |
| 63 | + "type": "ProblemHandler<never> | undefined", |
| 64 | + "def": "`handleProblem`\n\n" |
| 65 | + }, |
24 | 66 | { |
25 | 67 | "name": "fontSize", |
26 | 68 | "summary": "字体大小,当在\n`config`\n中存在时,当前值将被忽略。\n\n", |
|
33 | 75 | "type": "string | Scheme | undefined", |
34 | 76 | "def": "schemes 的第一个元素或是从 html 读取对应的变量作为默认值\n\n" |
35 | 77 | }, |
36 | | - { |
37 | | - "name": "schemes", |
38 | | - "summary": "支持的主题列表\n\n", |
39 | | - "remarks": "`schemes`\n下定义部分主题可以直接在此处使用。\n\n", |
40 | | - "type": "Map<string, Scheme> | undefined", |
41 | | - "def": "`new Map()`\n\n" |
42 | | - }, |
43 | 78 | { |
44 | 79 | "name": "mode", |
45 | 80 | "summary": "默认的主题模式,当在\n`config`\n中存在时,当前值将被忽略。\n\n", |
46 | 81 | "type": "\"system\" | \"dark\" | \"light\" | undefined", |
47 | 82 | "def": "'system'\n\n" |
48 | 83 | }, |
49 | | - { |
50 | | - "name": "palette", |
51 | | - "summary": "默认的主题调色板,当在\n`config`\n中存在时,当前值将被忽略。\n\n", |
52 | | - "type": "\"primary\" | \"secondary\" | \"tertiary\" | \"error\" | \"surface\" | undefined", |
53 | | - "def": "'surface'\n\n" |
54 | | - }, |
55 | 84 | { |
56 | 85 | "name": "transitionDuration", |
57 | 86 | "summary": "动画效果的时长,单位为 ms。当在\n`config`\n中存在时,当前值将被忽略。\n\n", |
|
83 | 112 | "def": "5000\n\n" |
84 | 113 | }, |
85 | 114 | { |
86 | | - "name": "messages", |
87 | | - "summary": "当前支持的语言列表以及加载方法\n\n", |
88 | | - "type": "Record<string, DictLoader[]>" |
89 | | - }, |
90 | | - { |
91 | | - "name": "title", |
92 | | - "summary": "网站的标题\n\n", |
93 | | - "remarks": "如果不为空,会和\n`titleSeparator`\n组成页面标题的后缀。\n\n", |
94 | | - "type": "string" |
95 | | - }, |
96 | | - { |
97 | | - "name": "titleSeparator", |
98 | | - "summary": "网页标题的分隔符\n\n", |
99 | | - "type": "string | undefined", |
100 | | - "def": "' - '\n\n" |
101 | | - }, |
102 | | - { |
103 | | - "name": "pageSizes", |
104 | | - "summary": "分页符中页码选项的默认值\n\n", |
105 | | - "type": "number[] | undefined", |
106 | | - "def": "[10, 20, 50, 100]\n\n" |
107 | | - }, |
108 | | - { |
109 | | - "name": "pageSize", |
110 | | - "summary": "表格等需要分页对象的每页默认数量\n\n", |
111 | | - "type": "number | undefined", |
112 | | - "def": "20\n\n" |
113 | | - }, |
114 | | - { |
115 | | - "name": "problemHandler", |
116 | | - "summary": "对\n`Problem`\n的处理函数\n\n", |
117 | | - "type": "ProblemHandler<never> | undefined", |
118 | | - "def": "`handleProblem`\n\n" |
| 115 | + "name": "notifyPosition", |
| 116 | + "summary": "通知的显示位置\n\n", |
| 117 | + "type": "\"top\" | \"bottom\" | undefined", |
| 118 | + "def": "'top'\n\n" |
119 | 119 | } |
120 | 120 | ], |
121 | 121 | "pkg": "@cmfx/components" |
|
127 | 127 | "type": "function useOptions(): [accessor: OptionsAccessor, origin: ReqOptions]", |
128 | 128 | "return": { |
129 | 129 | "summary": "返回一个元组,包含以下属性:\n- 0: 提供对组件库选项的存取功能;\n- 1: 组件库选项的原始值;\n\n", |
130 | | - "type": "[accessor: { switchConfig(id: string): void; reset(): void; setTitle(v: string): void; setFontSize(size: string): void; getFontSize(): string; setTransitionDuration(duration: number): void; getTransitionDuration(): number; setLocale(id: string): void; getLocale(): string; setDisplayStyle(style: DisplayStyle): void; getDisplayStyle(): DisplayStyle; setTimezone(tz: string): void; getTimezone(): string; setScheme(scheme: string | Scheme): void; getScheme(): Scheme; setMode(mode: Mode): void; getMode(): Mode; setStays(stay: number): void; getStays(): number; clearStorage(): void; }, origin: Required<Omit<Options, \"scheme\"> & { scheme: Scheme; }>]" |
| 130 | + "type": "[accessor: { switchConfig(id: string): void; reset(): void; setTitle(v: string): void; setFontSize(size: string): void; getFontSize(): string; setTransitionDuration(duration: number): void; getTransitionDuration(): number; setLocale(id: string): void; getLocale(): string; setDisplayStyle(style: DisplayStyle): void; getDisplayStyle(): DisplayStyle; setTimezone(tz: string): void; getTimezone(): string; setScheme(scheme: string | Scheme): void; getScheme(): Scheme; setMode(mode: Mode): void; getMode(): Mode; setStays(stay: number): void; getStays(): number; setNotifyPosition(position: NotifyPosition): void; getNotifyPosition(): NotifyPosition; clearStorage(): void; }, origin: Required<Omit<Options, \"scheme\"> & { scheme: Scheme; }>]" |
131 | 131 | }, |
132 | 132 | "pkg": "@cmfx/components" |
133 | 133 | }, |
|
0 commit comments