mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-08-05 16:07:34 +02:00
Code Issues Releases Wiki Activity

Export more interfaces and types

Browse Source
This commit is contained in:
David Wheatley
2021-07-31 22:39:32 +01:00
parent 23b79f7560
commit 3639b94362
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
js/src/admin/components/AdminPage.tsx
View File

@@ -51,18 +51,27 @@ interface CommonSettingsItemOptions extends Mithril.Attributes {
className?: string; className?: string;
} }
interface HTMLInputSettingsComponentOptions extends CommonSettingsItemOptions { /**
* Valid options for the setting component builder to generate an HTML input element.
*/
export interface HTMLInputSettingsComponentOptions extends CommonSettingsItemOptions {
/** /**
* Any valid HTML input `type` value. * Any valid HTML input `type` value.
*/ */
type: HTMLInputTypes; type: HTMLInputTypes;
} }
interface SwitchSettingComponentOptions extends CommonSettingsItemOptions { /**
* Valid options for the setting component builder to generate a Switch.
*/
export interface SwitchSettingComponentOptions extends CommonSettingsItemOptions {
type: 'bool' | 'checkbox' | 'switch' | 'boolean'; type: 'bool' | 'checkbox' | 'switch' | 'boolean';
} }
interface SelectSettingComponentOptions extends CommonSettingsItemOptions { /**
* Valid options for the setting component builder to generate a Select dropdown.
*/
export interface SelectSettingComponentOptions extends CommonSettingsItemOptions {
type: 'select' | 'dropdown' | 'selectdropdown'; type: 'select' | 'dropdown' | 'selectdropdown';
/** /**
* Map of values to their labels * Map of values to their labels
@@ -71,8 +80,14 @@ interface SelectSettingComponentOptions extends CommonSettingsItemOptions {
default: string; default: string;
} }
/**
* All valid options for the setting component builder.
*/
export type SettingsComponentOptions = HTMLInputSettingsComponentOptions | SwitchSettingComponentOptions | SelectSettingComponentOptions; export type SettingsComponentOptions = HTMLInputSettingsComponentOptions | SwitchSettingComponentOptions | SelectSettingComponentOptions;
/**
* Valid attrs that can be returned by the `headerInfo` function
*/
export type AdminHeaderAttrs = AdminHeaderOptions & Partial<Omit<Mithril.Attributes, 'class'>>; export type AdminHeaderAttrs = AdminHeaderOptions & Partial<Omit<Mithril.Attributes, 'class'>>;
export default class AdminPage extends Page { export default class AdminPage extends Page {