From 2158ee88817c5e8b9c829219cf671b8b20e6ac76 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Sun, 21 Apr 2024 00:51:06 +0000 Subject: [PATCH] upgrade deps && docs --- ...color_switch_color_switch.ColorSwitch.html | 2 +- ...e_force_color_scheme.ForceColorScheme.html | 2 +- ...nt_force_theme_force_theme.ForceTheme.html | 2 +- ...switcher_theme_switcher.ThemeSwitcher.html | 2 +- ...tcher_theme_switcher.useThemeSwitcher.html | 2 +- docs/functions/hooks_use_theme.useTheme.html | 2 +- ...r_side_wrapper.NextJsSSGThemeSwitcher.html | 2 +- ...server_side_wrapper.ServerSideWrapper.html | 2 +- docs/functions/utils.encodeState.html | 2 +- .../utils.getResolvedColorScheme.html | 2 +- docs/functions/utils.getResolvedTheme.html | 2 +- docs/functions/utils.parseState.html | 2 +- docs/functions/utils.resolveTheme.html | 2 +- ..._switch_color_switch.ColorSwitchProps.html | 6 +- ...eme_switcher_theme_switcher.DataProps.html | 4 +- ...her_theme_switcher.ThemeSwitcherProps.html | 6 +- ...e_switcher_theme_switcher.UpdateProps.html | 4 +- docs/interfaces/constants.ThemeStoreType.html | 4 +- ...e_wrapper.NextJsSSRThemeSwitcherProps.html | 168 +++++++++--------- ...r_side_wrapper.ServerSideWrapperProps.html | 168 +++++++++--------- docs/modules/client.html | 2 +- docs/modules/client_color_switch.html | 2 +- .../client_color_switch_color_switch.html | 2 +- docs/modules/client_force_color_scheme.html | 2 +- ...force_color_scheme_force_color_scheme.html | 2 +- docs/modules/client_force_theme.html | 2 +- .../client_force_theme_force_theme.html | 2 +- docs/modules/client_theme_switcher.html | 2 +- .../client_theme_switcher_theme_switcher.html | 2 +- docs/modules/constants.html | 2 +- docs/modules/hooks.html | 2 +- docs/modules/hooks_use_theme.html | 2 +- ...rver_side_wrapper_server_side_wrapper.html | 2 +- docs/modules/utils.html | 2 +- docs/types/constants.ColorSchemeType.html | 2 +- .../constants.ThemeStoreActionsType.html | 2 +- ...rapper_server_side_wrapper.ForcedPage.html | 2 +- docs/variables/constants.DEFAULT_ID.html | 2 +- docs/variables/constants.initialState.html | 2 +- 39 files changed, 212 insertions(+), 212 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index b55760df..21d2262f 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -4,4 +4,4 @@

Custom size & skipSystem

<ColorSwitch size={20} skipSystem />
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html index 5530252d..2aa71de6 100644 --- a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html +++ b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html @@ -1 +1 @@ -ForceColorScheme | Code Documentation

Function ForceColorScheme

Settings

Member Visibility

Theme

\ No newline at end of file +ForceColorScheme | Code Documentation

Function ForceColorScheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/client_force_theme_force_theme.ForceTheme.html b/docs/functions/client_force_theme_force_theme.ForceTheme.html index c9350f79..6f45421b 100644 --- a/docs/functions/client_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/client_force_theme_force_theme.ForceTheme.html @@ -1 +1 @@ -ForceTheme | Code Documentation

Function ForceTheme

Settings

Member Visibility

Theme

\ No newline at end of file +ForceTheme | Code Documentation

Function ForceTheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html index 93791d3a..036c3265 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -1,2 +1,2 @@ ThemeSwitcher | Code Documentation

Function ThemeSwitcher

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns null

Component

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html index fd4599ef..7eeeb966 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html @@ -1,3 +1,3 @@ useThemeSwitcher | Code Documentation

Function useThemeSwitcher

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/hooks_use_theme.useTheme.html b/docs/functions/hooks_use_theme.useTheme.html index cfda2e50..6ca91a6d 100644 --- a/docs/functions/hooks_use_theme.useTheme.html +++ b/docs/functions/hooks_use_theme.useTheme.html @@ -1 +1 @@ -useTheme | Code Documentation

Function useTheme

  • useTheme(targetId?): {
        colorSchemePref: ColorSchemeType;
        darkTheme: string;
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
        lightTheme: string;
        resolvedColorScheme: "dark" | "light";
        resolvedTheme: string;
        setColorSchemePref: ((arg) => void);
        setDarkTheme: ((arg) => void);
        setForcedColorScheme: ((arg) => void);
        setForcedTheme: ((arg) => void);
        setLightTheme: ((arg) => void);
        setTheme: ((arg) => void);
        setThemeSet: ((themeSet) => void);
        systemColorScheme: "dark" | "light";
        theme: string;
    }

  • Parameters

    • Optional targetId: string

    Returns {
        colorSchemePref: ColorSchemeType;
        darkTheme: string;
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
        lightTheme: string;
        resolvedColorScheme: "dark" | "light";
        resolvedTheme: string;
        setColorSchemePref: ((arg) => void);
        setDarkTheme: ((arg) => void);
        setForcedColorScheme: ((arg) => void);
        setForcedTheme: ((arg) => void);
        setLightTheme: ((arg) => void);
        setTheme: ((arg) => void);
        setThemeSet: ((themeSet) => void);
        systemColorScheme: "dark" | "light";
        theme: string;
    }

    • colorSchemePref: ColorSchemeType
    • darkTheme: string
    • Optional forcedColorScheme?: ColorSchemeType
    • Optional forcedTheme?: string
    • lightTheme: string
    • resolvedColorScheme: "dark" | "light"
    • resolvedTheme: string
    • setColorSchemePref: ((arg) => void)
    • setDarkTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setForcedColorScheme: ((arg) => void)
    • setForcedTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: undefined | string

          Returns void

    • setLightTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setThemeSet: ((themeSet) => void)
        • (themeSet): void

        • Parameters

          • themeSet: {
                darkTheme: string;
                lightTheme: string;
            }
            • darkTheme: string
            • lightTheme: string

          Returns void

    • systemColorScheme: "dark" | "light"
    • theme: string

Settings

Member Visibility

Theme

\ No newline at end of file +useTheme | Code Documentation

Function useTheme

  • useTheme(targetId?): {
        colorSchemePref: ColorSchemeType;
        darkTheme: string;
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
        lightTheme: string;
        resolvedColorScheme: "dark" | "light";
        resolvedTheme: string;
        setColorSchemePref: ((arg) => void);
        setDarkTheme: ((arg) => void);
        setForcedColorScheme: ((arg) => void);
        setForcedTheme: ((arg) => void);
        setLightTheme: ((arg) => void);
        setTheme: ((arg) => void);
        setThemeSet: ((themeSet) => void);
        systemColorScheme: "dark" | "light";
        theme: string;
    }

  • Parameters

    • Optional targetId: string

    Returns {
        colorSchemePref: ColorSchemeType;
        darkTheme: string;
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
        lightTheme: string;
        resolvedColorScheme: "dark" | "light";
        resolvedTheme: string;
        setColorSchemePref: ((arg) => void);
        setDarkTheme: ((arg) => void);
        setForcedColorScheme: ((arg) => void);
        setForcedTheme: ((arg) => void);
        setLightTheme: ((arg) => void);
        setTheme: ((arg) => void);
        setThemeSet: ((themeSet) => void);
        systemColorScheme: "dark" | "light";
        theme: string;
    }

    • colorSchemePref: ColorSchemeType
    • darkTheme: string
    • Optional forcedColorScheme?: ColorSchemeType
    • Optional forcedTheme?: string
    • lightTheme: string
    • resolvedColorScheme: "dark" | "light"
    • resolvedTheme: string
    • setColorSchemePref: ((arg) => void)
    • setDarkTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setForcedColorScheme: ((arg) => void)
    • setForcedTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: undefined | string

          Returns void

    • setLightTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setTheme: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: string

          Returns void

    • setThemeSet: ((themeSet) => void)
        • (themeSet): void

        • Parameters

          • themeSet: {
                darkTheme: string;
                lightTheme: string;
            }
            • darkTheme: string
            • lightTheme: string

          Returns void

    • systemColorScheme: "dark" | "light"
    • theme: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html index 061ffe3b..31ce4b68 100644 --- a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html +++ b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html @@ -1,3 +1,3 @@ NextJsSSGThemeSwitcher | Code Documentation

Function NextJsSSGThemeSwitcher

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html index 7fe52298..f24f199e 100644 --- a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html +++ b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html @@ -1,4 +1,4 @@ ServerSideWrapper | Code Documentation

Function ServerSideWrapper

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.encodeState.html b/docs/functions/utils.encodeState.html index 5d4766cb..9a483f1c 100644 --- a/docs/functions/utils.encodeState.html +++ b/docs/functions/utils.encodeState.html @@ -1 +1 @@ -encodeState | Code Documentation

Function encodeState

Settings

Member Visibility

Theme

\ No newline at end of file +encodeState | Code Documentation

Function encodeState

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.getResolvedColorScheme.html b/docs/functions/utils.getResolvedColorScheme.html index 02ee281d..0258ad87 100644 --- a/docs/functions/utils.getResolvedColorScheme.html +++ b/docs/functions/utils.getResolvedColorScheme.html @@ -1 +1 @@ -getResolvedColorScheme | Code Documentation

Function getResolvedColorScheme

Settings

Member Visibility

Theme

\ No newline at end of file +getResolvedColorScheme | Code Documentation

Function getResolvedColorScheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.getResolvedTheme.html b/docs/functions/utils.getResolvedTheme.html index f6d12473..27d92420 100644 --- a/docs/functions/utils.getResolvedTheme.html +++ b/docs/functions/utils.getResolvedTheme.html @@ -1 +1 @@ -getResolvedTheme | Code Documentation

Function getResolvedTheme

Settings

Member Visibility

Theme

\ No newline at end of file +getResolvedTheme | Code Documentation

Function getResolvedTheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.parseState.html b/docs/functions/utils.parseState.html index 5380e4bb..bab28bea 100644 --- a/docs/functions/utils.parseState.html +++ b/docs/functions/utils.parseState.html @@ -1 +1 @@ -parseState | Code Documentation

Function parseState

Settings

Member Visibility

Theme

\ No newline at end of file +parseState | Code Documentation

Function parseState

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.resolveTheme.html b/docs/functions/utils.resolveTheme.html index a3691998..91d86733 100644 --- a/docs/functions/utils.resolveTheme.html +++ b/docs/functions/utils.resolveTheme.html @@ -1 +1 @@ -resolveTheme | Code Documentation

Function resolveTheme

Settings

Member Visibility

Theme

\ No newline at end of file +resolveTheme | Code Documentation

Function resolveTheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html index c54addb8..b69bf684 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,5 +1,5 @@ -ColorSwitchProps | Code Documentation

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
}

Properties

size? +ColorSwitchProps | Code Documentation

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
}

Properties

size? skipSystem?

Properties

Optional size

size?: number

Diameter of the color switch

-

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

Settings

Member Visibility

Theme

On This Page

sizeskipSystem
\ No newline at end of file +

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

Settings

Member Visibility

Theme

On This Page

sizeskipSystem
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html index d18a5368..15b39c47 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html @@ -1,6 +1,6 @@ -DataProps | Code Documentation

Interface DataProps

interface DataProps {
    className: string;
    data-color-scheme?: "dark" | "light";
    data-csp?: ColorSchemeType;
    data-th?: string;
    data-theme?: string;
}

Properties

className +DataProps | Code Documentation

Interface DataProps

interface DataProps {
    className: string;
    data-color-scheme?: "dark" | "light";
    data-csp?: ColorSchemeType;
    data-th?: string;
    data-theme?: string;
}

Properties

className data-color-scheme? data-csp? data-th? data-theme? -

Properties

className

className: string

Optional data-color-scheme

data-color-scheme?: "dark" | "light"

Optional data-csp

data-csp?: ColorSchemeType

Optional data-th

data-th?: string

Optional data-theme

data-theme?: string

Settings

Member Visibility

Theme

On This Page

classNamedata-color-schemedata-cspdata-thdata-theme
\ No newline at end of file +

Properties

className

className: string

Optional data-color-scheme

data-color-scheme?: "dark" | "light"

Optional data-csp

data-csp?: ColorSchemeType

Optional data-th

data-th?: string

Optional data-theme

data-theme?: string

Settings

Member Visibility

Theme

On This Page

classNamedata-color-schemedata-cspdata-thdata-theme
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html index 95fbd084..01dc1ac8 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,8 +1,8 @@ ThemeSwitcherProps | Code Documentation

Interface ThemeSwitcherProps

todo - set persistance and cookies

-
interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? +
interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? forcedTheme? styles? targetSelector? themeTransition? -

Properties

Optional forcedColorScheme

forcedColorScheme?: ColorSchemeType

Optional forcedTheme

forcedTheme?: string

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optional targetSelector

targetSelector?: string

Optional themeTransition

themeTransition?: string

Settings

Member Visibility

Theme

On This Page

forcedColorSchemeforcedThemestylestargetSelectorthemeTransition
\ No newline at end of file +

Properties

Optional forcedColorScheme

forcedColorScheme?: ColorSchemeType

Optional forcedTheme

forcedTheme?: string

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optional targetSelector

targetSelector?: string

Optional themeTransition

themeTransition?: string

Settings

Member Visibility

Theme

On This Page

forcedColorSchemeforcedThemestylestargetSelectorthemeTransition
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html index 22e7558f..3dff4b02 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html @@ -1,5 +1,5 @@ -UpdateProps | Code Documentation

Interface UpdateProps

interface UpdateProps {
    resolvedColorScheme: "dark" | "light";
    resolvedColorSchemePref: ColorSchemeType;
    resolvedTheme: string;
    th: string;
}

Properties

resolvedColorScheme +UpdateProps | Code Documentation

Interface UpdateProps

interface UpdateProps {
    resolvedColorScheme: "dark" | "light";
    resolvedColorSchemePref: ColorSchemeType;
    resolvedTheme: string;
    th: string;
}

Properties

resolvedColorScheme resolvedColorSchemePref resolvedTheme th -

Properties

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

resolvedColorSchemePref

resolvedColorSchemePref: ColorSchemeType

resolvedTheme

resolvedTheme: string

th

th: string

Settings

Member Visibility

Theme

On This Page

resolvedColorSchemeresolvedColorSchemePrefresolvedThemeth
\ No newline at end of file +

Properties

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

resolvedColorSchemePref

resolvedColorSchemePref: ColorSchemeType

resolvedTheme

resolvedTheme: string

th

th: string

Settings

Member Visibility

Theme

On This Page

resolvedColorSchemeresolvedColorSchemePrefresolvedThemeth
\ No newline at end of file diff --git a/docs/interfaces/constants.ThemeStoreType.html b/docs/interfaces/constants.ThemeStoreType.html index 2737cdcb..4c7dbe06 100644 --- a/docs/interfaces/constants.ThemeStoreType.html +++ b/docs/interfaces/constants.ThemeStoreType.html @@ -1,8 +1,8 @@ -ThemeStoreType | Code Documentation

Interface ThemeStoreType

interface ThemeStoreType {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    lightTheme: string;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePref +ThemeStoreType | Code Documentation

Interface ThemeStoreType

interface ThemeStoreType {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    lightTheme: string;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePref darkTheme forcedColorScheme? forcedTheme? lightTheme systemColorScheme theme -

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

Optional forcedColorScheme

forcedColorScheme?: ColorSchemeType

Optional forcedTheme

forcedTheme?: string

lightTheme

lightTheme: string

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

colorSchemePrefdarkThemeforcedColorSchemeforcedThemelightThemesystemColorSchemetheme
\ No newline at end of file +

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

Optional forcedColorScheme

forcedColorScheme?: ColorSchemeType

Optional forcedTheme

forcedTheme?: string

lightTheme

lightTheme: string

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

colorSchemePrefdarkThemeforcedColorSchemeforcedThemelightThemesystemColorSchemetheme
\ No newline at end of file diff --git a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html index 3dd9016c..3ced792e 100644 --- a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html +++ b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html @@ -1,4 +1,4 @@ -NextJsSSRThemeSwitcherProps | Code Documentation

Interface NextJsSSRThemeSwitcherProps

interface NextJsSSRThemeSwitcherProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inert?: boolean;
    inlist?: any;
    inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionRun?: TransitionEventHandler<HTMLElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionStart?: TransitionEventHandler<HTMLElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    styles?: Record<string, string>;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    targetId?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy (view full)

Properties

about? +NextJsSSRThemeSwitcherProps | Code Documentation

Interface NextJsSSRThemeSwitcherProps

interface NextJsSSRThemeSwitcherProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inert?: boolean;
    inlist?: any;
    inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionRun?: TransitionEventHandler<HTMLElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionStart?: TransitionEventHandler<HTMLElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    styles?: Record<string, string>;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    targetId?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy (view full)

Properties

about? accept? acceptCharset? accessKey? @@ -377,155 +377,155 @@ wmode? wrap?

Properties

Optional about

about?: string

RDFa Attributes

-

Optional accept

accept?: string

Standard HTML Attributes

-

Optional acceptCharset

acceptCharset?: string

Optional accessKey

accessKey?: string

Standard HTML Attributes

-

Optional action

action?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional allowFullScreen

allowFullScreen?: boolean

Optional allowTransparency

allowTransparency?: boolean

Optional alt

alt?: string

Optional aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

-

Optional aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

-

Optional aria-autocomplete

aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +

Optional accept

accept?: string

Standard HTML Attributes

+

Optional acceptCharset

acceptCharset?: string

Optional accessKey

accessKey?: string

Standard HTML Attributes

+

Optional action

action?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional allowFullScreen

allowFullScreen?: boolean

Optional allowTransparency

allowTransparency?: boolean

Optional alt

alt?: string

Optional aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Optional aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

+

Optional aria-autocomplete

aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

-

Optional aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

+

Optional aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

-

Optional aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

+

Optional aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

-

Optional aria-busy

aria-busy?: Booleanish

Optional aria-checked

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

Optional aria-busy

aria-busy?: Booleanish

Optional aria-checked

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.
-

Optional aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

+

Optional aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

-

Optional aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

+

Optional aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.
-

Optional aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

+

Optional aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

-

Optional aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

Optional aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.
-

Optional aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

Optional aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

-

Optional aria-current

aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

-

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

+

Optional aria-current

aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

+

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

-

Optional aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

+

Optional aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

-

Optional aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

+

Optional aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

-

Optional aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

Optional aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.
-

Optional aria-dropeffect

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

+

Optional aria-dropeffect

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

-

Optional aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

+

Optional aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.
-

Optional aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

-

Optional aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +

Optional aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Optional aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

-

Optional aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

Optional aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

-

Optional aria-haspopup

aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

-

Optional aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

+

Optional aria-haspopup

aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Optional aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

-

Optional aria-invalid

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

+

Optional aria-invalid

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

-

Optional aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

-

Optional aria-label

aria-label?: string

Defines a string value that labels the current element.

+

Optional aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Optional aria-label

aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

-

Optional aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

+

Optional aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

-

Optional aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

-

Optional aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

-

Optional aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

-

Optional aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

-

Optional aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

-

Optional aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

-

Optional aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +

Optional aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

+

Optional aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

+

Optional aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

+

Optional aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Optional aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

+

Optional aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Optional aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

-

Optional aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +

Optional aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

-

Optional aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+

Optional aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

-

Optional aria-pressed

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

+

Optional aria-pressed

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.
-

Optional aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

+

Optional aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

-

Optional aria-relevant

aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

Optional aria-relevant

aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

-

Optional aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

-

Optional aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

-

Optional aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

+

Optional aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

+

Optional aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

+

Optional aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

-

Optional aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

+

Optional aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.
-

Optional aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

+

Optional aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

-

Optional aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

Optional aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.
-

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

+

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.
-

Optional aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+

Optional aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

-

Optional aria-sort

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

-

Optional aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

-

Optional aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

-

Optional aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

+

Optional aria-sort

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Optional aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

+

Optional aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

+

Optional aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

-

Optional aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-

Optional as

as?: string

Optional async

async?: boolean

Optional autoCapitalize

autoCapitalize?: string

Non-standard Attributes

-

Optional autoComplete

autoComplete?: string

Optional autoCorrect

autoCorrect?: string

Optional autoFocus

autoFocus?: boolean

Optional autoPlay

autoPlay?: boolean

Optional autoSave

autoSave?: string

Optional capture

capture?: boolean | "user" | "environment"

Optional cellPadding

cellPadding?: string | number

Optional cellSpacing

cellSpacing?: string | number

Optional challenge

challenge?: string

Optional charSet

charSet?: string

Optional checked

checked?: boolean

Optional children

children?: ReactNode

Optional cite

cite?: string

Optional classID

classID?: string

Optional className

className?: string

Optional colSpan

colSpan?: number

Optional color

color?: string

Optional cols

cols?: number

Optional content

content?: string

Optional contentEditable

contentEditable?: Booleanish | "inherit" | "plaintext-only"

Optional contextMenu

contextMenu?: string

Optional controls

controls?: boolean

Optional coords

coords?: string

Optional crossOrigin

crossOrigin?: CrossOrigin

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. +

Optional aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Optional as

as?: string

Optional async

async?: boolean

Optional autoCapitalize

autoCapitalize?: string

Non-standard Attributes

+

Optional autoComplete

autoComplete?: string

Optional autoCorrect

autoCorrect?: string

Optional autoFocus

autoFocus?: boolean

Optional autoPlay

autoPlay?: boolean

Optional autoSave

autoSave?: string

Optional capture

capture?: boolean | "user" | "environment"

Optional cellPadding

cellPadding?: string | number

Optional cellSpacing

cellSpacing?: string | number

Optional challenge

challenge?: string

Optional charSet

charSet?: string

Optional checked

checked?: boolean

Optional children

children?: ReactNode

Optional cite

cite?: string

Optional classID

classID?: string

Optional className

className?: string

Optional colSpan

colSpan?: number

Optional color

color?: string

Optional cols

cols?: number

Optional content

content?: string

Optional contentEditable

contentEditable?: Booleanish | "inherit" | "plaintext-only"

Optional contextMenu

contextMenu?: string

Optional controls

controls?: boolean

Optional coords

coords?: string

Optional crossOrigin

crossOrigin?: CrossOrigin

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. But unfortunately we're mixing renderer-specific type declarations.

    -

Optional data

data?: string

Optional datatype

datatype?: string

Optional dateTime

dateTime?: string

Optional default

default?: boolean

Optional defaultChecked

defaultChecked?: boolean

React-specific Attributes

-

Optional defaultValue

defaultValue?: string | number | readonly string[]

Optional defer

defer?: boolean

Optional dir

dir?: string

Optional disabled

disabled?: boolean

Optional download

download?: any

Optional draggable

draggable?: Booleanish

Optional encType

encType?: string

Optional forcedPages

forcedPages?: ForcedPage[]

Optional form

form?: string

Optional formAction

formAction?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional formEncType

formEncType?: string

Optional formMethod

formMethod?: string

Optional formNoValidate

formNoValidate?: boolean

Optional formTarget

formTarget?: string

Optional frameBorder

frameBorder?: string | number

Optional headers

headers?: string

Optional height

height?: string | number

Optional hidden

hidden?: boolean

Optional high

high?: number

Optional href

href?: string

Optional hrefLang

hrefLang?: string

Optional htmlFor

htmlFor?: string

Optional httpEquiv

httpEquiv?: string

Optional id

id?: string

Optional inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

-

Optional inlist

inlist?: any

Optional inputMode

inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

+

Optional data

data?: string

Optional datatype

datatype?: string

Optional dateTime

dateTime?: string

Optional default

default?: boolean

Optional defaultChecked

defaultChecked?: boolean

React-specific Attributes

+

Optional defaultValue

defaultValue?: string | number | readonly string[]

Optional defer

defer?: boolean

Optional dir

dir?: string

Optional disabled

disabled?: boolean

Optional download

download?: any

Optional draggable

draggable?: Booleanish

Optional encType

encType?: string

Optional forcedPages

forcedPages?: ForcedPage[]

Optional form

form?: string

Optional formAction

formAction?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional formEncType

formEncType?: string

Optional formMethod

formMethod?: string

Optional formNoValidate

formNoValidate?: boolean

Optional formTarget

formTarget?: string

Optional frameBorder

frameBorder?: string | number

Optional headers

headers?: string

Optional height

height?: string | number

Optional hidden

hidden?: boolean

Optional high

high?: number

Optional href

href?: string

Optional hrefLang

hrefLang?: string

Optional htmlFor

htmlFor?: string

Optional httpEquiv

httpEquiv?: string

Optional id

id?: string

Optional inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

+

Optional inlist

inlist?: any

Optional inputMode

inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

-

Optional integrity

integrity?: string

Optional is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

+

Optional integrity

integrity?: string

Optional is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

-

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional key

key?: null | Key

Optional keyParams

keyParams?: string

Optional keyType

keyType?: string

Optional kind

kind?: string

Optional label

label?: string

Optional lang

lang?: string

Optional list

list?: string

Optional loop

loop?: boolean

Optional low

low?: number

Optional manifest

manifest?: string

Optional marginHeight

marginHeight?: number

Optional marginWidth

marginWidth?: number

Optional max

max?: string | number

Optional maxLength

maxLength?: number

Optional media

media?: string

Optional mediaGroup

mediaGroup?: string

Optional method

method?: string

Optional min

min?: string | number

Optional minLength

minLength?: number

Optional multiple

multiple?: boolean

Optional muted

muted?: boolean

Optional name

name?: string

Optional noValidate

noValidate?: boolean

Optional nonce

nonce?: string

Optional onAbort

onAbort?: ReactEventHandler<HTMLElement>

Media Events

-

Optional onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLElement>

Optional onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLElement>

Optional onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

-

Optional onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLElement>

Optional onAuxClick

onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

-

Optional onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLElement>

Optional onBeforeInput

onBeforeInput?: FormEventHandler<HTMLElement>

Optional onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLElement>

Optional onBlur

onBlur?: FocusEventHandler<HTMLElement>

Optional onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLElement>

Optional onCanPlay

onCanPlay?: ReactEventHandler<HTMLElement>

Optional onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLElement>

Optional onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>

Optional onChange

onChange?: FormEventHandler<HTMLElement>

Form Events

-

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLElement>

Optional onClick

onClick?: MouseEventHandler<HTMLElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLElement>

Optional onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

-

Optional onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLElement>

Optional onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLElement>

Optional onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLElement>

Optional onCopy

onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

-

Optional onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLElement>

Optional onCut

onCut?: ClipboardEventHandler<HTMLElement>

Optional onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLElement>

Optional onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLElement>

Optional onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLElement>

Optional onDrag

onDrag?: DragEventHandler<HTMLElement>

Optional onDragCapture

onDragCapture?: DragEventHandler<HTMLElement>

Optional onDragEnd

onDragEnd?: DragEventHandler<HTMLElement>

Optional onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLElement>

Optional onDragEnter

onDragEnter?: DragEventHandler<HTMLElement>

Optional onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLElement>

Optional onDragExit

onDragExit?: DragEventHandler<HTMLElement>

Optional onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLElement>

Optional onDragLeave

onDragLeave?: DragEventHandler<HTMLElement>

Optional onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLElement>

Optional onDragOver

onDragOver?: DragEventHandler<HTMLElement>

Optional onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLElement>

Optional onDragStart

onDragStart?: DragEventHandler<HTMLElement>

Optional onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLElement>

Optional onDrop

onDrop?: DragEventHandler<HTMLElement>

Optional onDropCapture

onDropCapture?: DragEventHandler<HTMLElement>

Optional onDurationChange

onDurationChange?: ReactEventHandler<HTMLElement>

Optional onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLElement>

Optional onEmptied

onEmptied?: ReactEventHandler<HTMLElement>

Optional onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLElement>

Optional onEncrypted

onEncrypted?: ReactEventHandler<HTMLElement>

Optional onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLElement>

Optional onEnded

onEnded?: ReactEventHandler<HTMLElement>

Optional onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLElement>

Optional onError

onError?: ReactEventHandler<HTMLElement>

Optional onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLElement>

Optional onFocus

onFocus?: FocusEventHandler<HTMLElement>

Focus Events

-

Optional onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLElement>

Optional onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onInput

onInput?: FormEventHandler<HTMLElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLElement>

Optional onInvalid

onInvalid?: FormEventHandler<HTMLElement>

Optional onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

-

Optional onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLElement>

Optional onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLElement>

Optional onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLElement>

Optional onLoad

onLoad?: ReactEventHandler<HTMLElement>

Image Events

-

Optional onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLElement>

Optional onLoadStart

onLoadStart?: ReactEventHandler<HTMLElement>

Optional onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedData

onLoadedData?: ReactEventHandler<HTMLElement>

Optional onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>

Optional onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onMouseDown

onMouseDown?: MouseEventHandler<HTMLElement>

Optional onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLElement>

Optional onMouseMove

onMouseMove?: MouseEventHandler<HTMLElement>

Optional onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOut

onMouseOut?: MouseEventHandler<HTMLElement>

Optional onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLElement>

Optional onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLElement>

Optional onMouseUp

onMouseUp?: MouseEventHandler<HTMLElement>

Optional onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLElement>

Optional onPaste

onPaste?: ClipboardEventHandler<HTMLElement>

Optional onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLElement>

Optional onPause

onPause?: ReactEventHandler<HTMLElement>

Optional onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLElement>

Optional onPlay

onPlay?: ReactEventHandler<HTMLElement>

Optional onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLElement>

Optional onPlaying

onPlaying?: ReactEventHandler<HTMLElement>

Optional onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLElement>

Optional onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLElement>

Optional onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLElement>

Optional onPointerDown

onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

-

Optional onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLElement>

Optional onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLElement>

Optional onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLElement>

Optional onPointerMove

onPointerMove?: PointerEventHandler<HTMLElement>

Optional onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOut

onPointerOut?: PointerEventHandler<HTMLElement>

Optional onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOver

onPointerOver?: PointerEventHandler<HTMLElement>

Optional onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLElement>

Optional onPointerUp

onPointerUp?: PointerEventHandler<HTMLElement>

Optional onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLElement>

Optional onProgress

onProgress?: ReactEventHandler<HTMLElement>

Optional onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLElement>

Optional onRateChange

onRateChange?: ReactEventHandler<HTMLElement>

Optional onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLElement>

Optional onReset

onReset?: FormEventHandler<HTMLElement>

Optional onResetCapture

onResetCapture?: FormEventHandler<HTMLElement>

Optional onResize

onResize?: ReactEventHandler<HTMLElement>

Optional onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLElement>

Optional onScroll

onScroll?: UIEventHandler<HTMLElement>

UI Events

-

Optional onScrollCapture

onScrollCapture?: UIEventHandler<HTMLElement>

Optional onSeeked

onSeeked?: ReactEventHandler<HTMLElement>

Optional onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLElement>

Optional onSeeking

onSeeking?: ReactEventHandler<HTMLElement>

Optional onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLElement>

Optional onSelect

onSelect?: ReactEventHandler<HTMLElement>

Selection Events

-

Optional onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLElement>

Optional onStalled

onStalled?: ReactEventHandler<HTMLElement>

Optional onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLElement>

Optional onSubmit

onSubmit?: FormEventHandler<HTMLElement>

Optional onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLElement>

Optional onSuspend

onSuspend?: ReactEventHandler<HTMLElement>

Optional onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLElement>

Optional onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLElement>

Optional onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

-

Optional onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLElement>

Optional onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLElement>

Optional onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLElement>

Optional onTouchMove

onTouchMove?: TouchEventHandler<HTMLElement>

Optional onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLElement>

Optional onTouchStart

onTouchStart?: TouchEventHandler<HTMLElement>

Optional onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLElement>

Optional onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLElement>

Transition Events

-

Optional onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

-

Optional onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLElement>

Optional onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLElement>

Optional onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLElement>

Optional onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLElement>

Optional onWaiting

onWaiting?: ReactEventHandler<HTMLElement>

Optional onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLElement>

Optional onWheel

onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

-

Optional onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLElement>

Optional open

open?: boolean

Optional optimum

optimum?: number

Optional pattern

pattern?: string

Optional placeholder

placeholder?: string

Optional playsInline

playsInline?: boolean

Optional poster

poster?: string

Optional prefix

prefix?: string

Optional preload

preload?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Unknown

-

Optional readOnly

readOnly?: boolean

Optional ref

ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. +

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional key

key?: null | Key

Optional keyParams

keyParams?: string

Optional keyType

keyType?: string

Optional kind

kind?: string

Optional label

label?: string

Optional lang

lang?: string

Optional list

list?: string

Optional loop

loop?: boolean

Optional low

low?: number

Optional manifest

manifest?: string

Optional marginHeight

marginHeight?: number

Optional marginWidth

marginWidth?: number

Optional max

max?: string | number

Optional maxLength

maxLength?: number

Optional media

media?: string

Optional mediaGroup

mediaGroup?: string

Optional method

method?: string

Optional min

min?: string | number

Optional minLength

minLength?: number

Optional multiple

multiple?: boolean

Optional muted

muted?: boolean

Optional name

name?: string

Optional noValidate

noValidate?: boolean

Optional nonce

nonce?: string

Optional onAbort

onAbort?: ReactEventHandler<HTMLElement>

Media Events

+

Optional onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLElement>

Optional onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLElement>

Optional onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

+

Optional onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLElement>

Optional onAuxClick

onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

+

Optional onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLElement>

Optional onBeforeInput

onBeforeInput?: FormEventHandler<HTMLElement>

Optional onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLElement>

Optional onBlur

onBlur?: FocusEventHandler<HTMLElement>

Optional onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLElement>

Optional onCanPlay

onCanPlay?: ReactEventHandler<HTMLElement>

Optional onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLElement>

Optional onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>

Optional onChange

onChange?: FormEventHandler<HTMLElement>

Form Events

+

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLElement>

Optional onClick

onClick?: MouseEventHandler<HTMLElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLElement>

Optional onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

+

Optional onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLElement>

Optional onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLElement>

Optional onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLElement>

Optional onCopy

onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

+

Optional onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLElement>

Optional onCut

onCut?: ClipboardEventHandler<HTMLElement>

Optional onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLElement>

Optional onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLElement>

Optional onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLElement>

Optional onDrag

onDrag?: DragEventHandler<HTMLElement>

Optional onDragCapture

onDragCapture?: DragEventHandler<HTMLElement>

Optional onDragEnd

onDragEnd?: DragEventHandler<HTMLElement>

Optional onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLElement>

Optional onDragEnter

onDragEnter?: DragEventHandler<HTMLElement>

Optional onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLElement>

Optional onDragExit

onDragExit?: DragEventHandler<HTMLElement>

Optional onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLElement>

Optional onDragLeave

onDragLeave?: DragEventHandler<HTMLElement>

Optional onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLElement>

Optional onDragOver

onDragOver?: DragEventHandler<HTMLElement>

Optional onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLElement>

Optional onDragStart

onDragStart?: DragEventHandler<HTMLElement>

Optional onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLElement>

Optional onDrop

onDrop?: DragEventHandler<HTMLElement>

Optional onDropCapture

onDropCapture?: DragEventHandler<HTMLElement>

Optional onDurationChange

onDurationChange?: ReactEventHandler<HTMLElement>

Optional onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLElement>

Optional onEmptied

onEmptied?: ReactEventHandler<HTMLElement>

Optional onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLElement>

Optional onEncrypted

onEncrypted?: ReactEventHandler<HTMLElement>

Optional onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLElement>

Optional onEnded

onEnded?: ReactEventHandler<HTMLElement>

Optional onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLElement>

Optional onError

onError?: ReactEventHandler<HTMLElement>

Optional onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLElement>

Optional onFocus

onFocus?: FocusEventHandler<HTMLElement>

Focus Events

+

Optional onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLElement>

Optional onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onInput

onInput?: FormEventHandler<HTMLElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLElement>

Optional onInvalid

onInvalid?: FormEventHandler<HTMLElement>

Optional onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

+

Optional onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLElement>

Optional onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLElement>

Optional onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLElement>

Optional onLoad

onLoad?: ReactEventHandler<HTMLElement>

Image Events

+

Optional onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLElement>

Optional onLoadStart

onLoadStart?: ReactEventHandler<HTMLElement>

Optional onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedData

onLoadedData?: ReactEventHandler<HTMLElement>

Optional onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>

Optional onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onMouseDown

onMouseDown?: MouseEventHandler<HTMLElement>

Optional onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLElement>

Optional onMouseMove

onMouseMove?: MouseEventHandler<HTMLElement>

Optional onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOut

onMouseOut?: MouseEventHandler<HTMLElement>

Optional onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLElement>

Optional onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLElement>

Optional onMouseUp

onMouseUp?: MouseEventHandler<HTMLElement>

Optional onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLElement>

Optional onPaste

onPaste?: ClipboardEventHandler<HTMLElement>

Optional onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLElement>

Optional onPause

onPause?: ReactEventHandler<HTMLElement>

Optional onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLElement>

Optional onPlay

onPlay?: ReactEventHandler<HTMLElement>

Optional onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLElement>

Optional onPlaying

onPlaying?: ReactEventHandler<HTMLElement>

Optional onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLElement>

Optional onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLElement>

Optional onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLElement>

Optional onPointerDown

onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

+

Optional onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLElement>

Optional onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLElement>

Optional onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLElement>

Optional onPointerMove

onPointerMove?: PointerEventHandler<HTMLElement>

Optional onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOut

onPointerOut?: PointerEventHandler<HTMLElement>

Optional onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOver

onPointerOver?: PointerEventHandler<HTMLElement>

Optional onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLElement>

Optional onPointerUp

onPointerUp?: PointerEventHandler<HTMLElement>

Optional onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLElement>

Optional onProgress

onProgress?: ReactEventHandler<HTMLElement>

Optional onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLElement>

Optional onRateChange

onRateChange?: ReactEventHandler<HTMLElement>

Optional onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLElement>

Optional onReset

onReset?: FormEventHandler<HTMLElement>

Optional onResetCapture

onResetCapture?: FormEventHandler<HTMLElement>

Optional onResize

onResize?: ReactEventHandler<HTMLElement>

Optional onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLElement>

Optional onScroll

onScroll?: UIEventHandler<HTMLElement>

UI Events

+

Optional onScrollCapture

onScrollCapture?: UIEventHandler<HTMLElement>

Optional onSeeked

onSeeked?: ReactEventHandler<HTMLElement>

Optional onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLElement>

Optional onSeeking

onSeeking?: ReactEventHandler<HTMLElement>

Optional onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLElement>

Optional onSelect

onSelect?: ReactEventHandler<HTMLElement>

Selection Events

+

Optional onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLElement>

Optional onStalled

onStalled?: ReactEventHandler<HTMLElement>

Optional onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLElement>

Optional onSubmit

onSubmit?: FormEventHandler<HTMLElement>

Optional onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLElement>

Optional onSuspend

onSuspend?: ReactEventHandler<HTMLElement>

Optional onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLElement>

Optional onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLElement>

Optional onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

+

Optional onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLElement>

Optional onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLElement>

Optional onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLElement>

Optional onTouchMove

onTouchMove?: TouchEventHandler<HTMLElement>

Optional onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLElement>

Optional onTouchStart

onTouchStart?: TouchEventHandler<HTMLElement>

Optional onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLElement>

Optional onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLElement>

Transition Events

+

Optional onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

+

Optional onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLElement>

Optional onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLElement>

Optional onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLElement>

Optional onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLElement>

Optional onWaiting

onWaiting?: ReactEventHandler<HTMLElement>

Optional onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLElement>

Optional onWheel

onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

+

Optional onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLElement>

Optional open

open?: boolean

Optional optimum

optimum?: number

Optional pattern

pattern?: string

Optional placeholder

placeholder?: string

Optional playsInline

playsInline?: boolean

Optional poster

poster?: string

Optional prefix

prefix?: string

Optional preload

preload?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Unknown

+

Optional readOnly

readOnly?: boolean

Optional ref

ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See

React Docs

-

Optional rel

rel?: string

Optional required

required?: boolean

Optional resource

resource?: string

Optional results

results?: number

Optional rev

rev?: string

Optional reversed

reversed?: boolean

Optional role

role?: AriaRole

WAI-ARIA

-

Optional rowSpan

rowSpan?: number

Optional rows

rows?: number

Optional sandbox

sandbox?: string

Optional scope

scope?: string

Optional scoped

scoped?: boolean

Optional scrolling

scrolling?: string

Optional seamless

seamless?: boolean

Optional security

security?: string

Optional selected

selected?: boolean

Optional shape

shape?: string

Optional size

size?: number

Optional sizes

sizes?: string

Optional slot

slot?: string

Optional span

span?: number

Optional spellCheck

spellCheck?: Booleanish

Optional src

src?: string

Optional srcDoc

srcDoc?: string

Optional srcLang

srcLang?: string

Optional srcSet

srcSet?: string

Optional start

start?: number

Optional step

step?: string | number

Optional style

style?: CSSProperties

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optional summary

summary?: string

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional tabIndex

tabIndex?: number

Optional tag

tag?: keyof IntrinsicElements

Default Value

'div'
+

Optional rel

rel?: string

Optional required

required?: boolean

Optional resource

resource?: string

Optional results

results?: number

Optional rev

rev?: string

Optional reversed

reversed?: boolean

Optional role

role?: AriaRole

WAI-ARIA

+

Optional rowSpan

rowSpan?: number

Optional rows

rows?: number

Optional sandbox

sandbox?: string

Optional scope

scope?: string

Optional scoped

scoped?: boolean

Optional scrolling

scrolling?: string

Optional seamless

seamless?: boolean

Optional security

security?: string

Optional selected

selected?: boolean

Optional shape

shape?: string

Optional size

size?: number

Optional sizes

sizes?: string

Optional slot

slot?: string

Optional span

span?: number

Optional spellCheck

spellCheck?: Booleanish

Optional src

src?: string

Optional srcDoc

srcDoc?: string

Optional srcLang

srcLang?: string

Optional srcSet

srcSet?: string

Optional start

start?: number

Optional step

step?: string | number

Optional style

style?: CSSProperties

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optional summary

summary?: string

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional tabIndex

tabIndex?: number

Optional tag

tag?: keyof IntrinsicElements

Default Value

'div'
-

Optional target

target?: string

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional type

type?: string

Optional typeof

typeof?: string

Optional unselectable

unselectable?: "on" | "off"

Optional useMap

useMap?: string

Optional value

value?: string | number | readonly string[]

Optional vocab

vocab?: string

Optional width

width?: string | number

Optional wmode

wmode?: string

Optional wrap

wrap?: string

Settings

Member Visibility

Theme

On This Page

aboutacceptacceptCharsetaccessKeyactionallowFullScreenallowTransparencyaltaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasasyncautoCapitalizeautoCompleteautoCorrectautoFocusautoPlayautoSavecapturecellPaddingcellSpacingchallengecharSetcheckedchildrenciteclassIDclassNamecolSpancolorcolscontentcontentEditablecontextMenucontrolscoordscrossOrigindangerouslySetInnerHTMLdatadatatypedateTimedefaultdefaultCheckeddefaultValuedeferdirdisableddownloaddraggableencTypeforcedPagesformformActionformEncTypeformMethodformNoValidateformTargetframeBorderheadersheighthiddenhighhrefhrefLanghtmlForhttpEquividinertinlistinputModeintegrityisitemIDitemPropitemRefitemScopeitemTypekeykeyParamskeyTypekindlabellanglistlooplowmanifestmarginHeightmarginWidthmaxmaxLengthmediamediaGroupmethodminminLengthmultiplemutednamenoValidatenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureopenoptimumpatternplaceholderplaysInlineposterprefixpreloadpropertyradioGroupreadOnlyrefrelrequiredresourceresultsrevreversedrolerowSpanrowssandboxscopescopedscrollingseamlesssecurityselectedshapesizesizesslotspanspellChecksrcsrcDocsrcLangsrcSetstartstepstylestylessummarysuppressContentEditableWarningsuppressHydrationWarningtabIndextagtargettargetIdtitletranslatetypetypeofunselectableuseMapvaluevocabwidthwmodewrap
\ No newline at end of file +

Optional target

target?: string

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional type

type?: string

Optional typeof

typeof?: string

Optional unselectable

unselectable?: "on" | "off"

Optional useMap

useMap?: string

Optional value

value?: string | number | readonly string[]

Optional vocab

vocab?: string

Optional width

width?: string | number

Optional wmode

wmode?: string

Optional wrap

wrap?: string

Settings

Member Visibility

Theme

On This Page

aboutacceptacceptCharsetaccessKeyactionallowFullScreenallowTransparencyaltaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasasyncautoCapitalizeautoCompleteautoCorrectautoFocusautoPlayautoSavecapturecellPaddingcellSpacingchallengecharSetcheckedchildrenciteclassIDclassNamecolSpancolorcolscontentcontentEditablecontextMenucontrolscoordscrossOrigindangerouslySetInnerHTMLdatadatatypedateTimedefaultdefaultCheckeddefaultValuedeferdirdisableddownloaddraggableencTypeforcedPagesformformActionformEncTypeformMethodformNoValidateformTargetframeBorderheadersheighthiddenhighhrefhrefLanghtmlForhttpEquividinertinlistinputModeintegrityisitemIDitemPropitemRefitemScopeitemTypekeykeyParamskeyTypekindlabellanglistlooplowmanifestmarginHeightmarginWidthmaxmaxLengthmediamediaGroupmethodminminLengthmultiplemutednamenoValidatenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureopenoptimumpatternplaceholderplaysInlineposterprefixpreloadpropertyradioGroupreadOnlyrefrelrequiredresourceresultsrevreversedrolerowSpanrowssandboxscopescopedscrollingseamlesssecurityselectedshapesizesizesslotspanspellChecksrcsrcDocsrcLangsrcSetstartstepstylestylessummarysuppressContentEditableWarningsuppressHydrationWarningtabIndextagtargettargetIdtitletranslatetypetypeofunselectableuseMapvaluevocabwidthwmodewrap
\ No newline at end of file diff --git a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html index dc068292..28acf6d3 100644 --- a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html +++ b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html @@ -1,4 +1,4 @@ -ServerSideWrapperProps | Code Documentation

Interface ServerSideWrapperProps

interface ServerSideWrapperProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inert?: boolean;
    inlist?: any;
    inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionRun?: TransitionEventHandler<HTMLElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionStart?: TransitionEventHandler<HTMLElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    styles?: Record<string, string>;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    targetId?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy (view full)

Properties

about? +ServerSideWrapperProps | Code Documentation

Interface ServerSideWrapperProps

interface ServerSideWrapperProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inert?: boolean;
    inlist?: any;
    inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionRun?: TransitionEventHandler<HTMLElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionStart?: TransitionEventHandler<HTMLElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    styles?: Record<string, string>;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    targetId?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy (view full)

Properties

about? accept? acceptCharset? accessKey? @@ -377,155 +377,155 @@ wmode? wrap?

Properties

Optional about

about?: string

RDFa Attributes

-

Optional accept

accept?: string

Standard HTML Attributes

-

Optional acceptCharset

acceptCharset?: string

Optional accessKey

accessKey?: string

Standard HTML Attributes

-

Optional action

action?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional allowFullScreen

allowFullScreen?: boolean

Optional allowTransparency

allowTransparency?: boolean

Optional alt

alt?: string

Optional aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

-

Optional aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

-

Optional aria-autocomplete

aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +

Optional accept

accept?: string

Standard HTML Attributes

+

Optional acceptCharset

acceptCharset?: string

Optional accessKey

accessKey?: string

Standard HTML Attributes

+

Optional action

action?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional allowFullScreen

allowFullScreen?: boolean

Optional allowTransparency

allowTransparency?: boolean

Optional alt

alt?: string

Optional aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+

Optional aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

+

Optional aria-autocomplete

aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

-

Optional aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

+

Optional aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

-

Optional aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

+

Optional aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

-

Optional aria-busy

aria-busy?: Booleanish

Optional aria-checked

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+

Optional aria-busy

aria-busy?: Booleanish

Optional aria-checked

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.
-

Optional aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

+

Optional aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

-

Optional aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

+

Optional aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.
-

Optional aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

+

Optional aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

-

Optional aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+

Optional aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.
-

Optional aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+

Optional aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

-

Optional aria-current

aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

-

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

+

Optional aria-current

aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

+

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

-

Optional aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

+

Optional aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

-

Optional aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

+

Optional aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

-

Optional aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+

Optional aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.
-

Optional aria-dropeffect

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

+

Optional aria-dropeffect

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

-

Optional aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

+

Optional aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.
-

Optional aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

-

Optional aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +

Optional aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+

Optional aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

-

Optional aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

+

Optional aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

-

Optional aria-haspopup

aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

-

Optional aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

+

Optional aria-haspopup

aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+

Optional aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

-

Optional aria-invalid

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

+

Optional aria-invalid

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

-

Optional aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

-

Optional aria-label

aria-label?: string

Defines a string value that labels the current element.

+

Optional aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+

Optional aria-label

aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

-

Optional aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

+

Optional aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

-

Optional aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

-

Optional aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

-

Optional aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

-

Optional aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

-

Optional aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

-

Optional aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

-

Optional aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +

Optional aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

+

Optional aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

+

Optional aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

+

Optional aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

+

Optional aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

+

Optional aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+

Optional aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

-

Optional aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +

Optional aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

-

Optional aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+

Optional aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

-

Optional aria-pressed

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

+

Optional aria-pressed

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.
-

Optional aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

+

Optional aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

-

Optional aria-relevant

aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+

Optional aria-relevant

aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

-

Optional aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

-

Optional aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

-

Optional aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

+

Optional aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

+

Optional aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

+

Optional aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

-

Optional aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

+

Optional aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.
-

Optional aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

+

Optional aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

-

Optional aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+

Optional aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.
-

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

+

Optional aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.
-

Optional aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+

Optional aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

-

Optional aria-sort

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

-

Optional aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

-

Optional aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

-

Optional aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

+

Optional aria-sort

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

+

Optional aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

+

Optional aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

+

Optional aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

-

Optional aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-

Optional as

as?: string

Optional async

async?: boolean

Optional autoCapitalize

autoCapitalize?: string

Non-standard Attributes

-

Optional autoComplete

autoComplete?: string

Optional autoCorrect

autoCorrect?: string

Optional autoFocus

autoFocus?: boolean

Optional autoPlay

autoPlay?: boolean

Optional autoSave

autoSave?: string

Optional capture

capture?: boolean | "user" | "environment"

Optional cellPadding

cellPadding?: string | number

Optional cellSpacing

cellSpacing?: string | number

Optional challenge

challenge?: string

Optional charSet

charSet?: string

Optional checked

checked?: boolean

Optional children

children?: ReactNode

Optional cite

cite?: string

Optional classID

classID?: string

Optional className

className?: string

Optional colSpan

colSpan?: number

Optional color

color?: string

Optional cols

cols?: number

Optional content

content?: string

Optional contentEditable

contentEditable?: Booleanish | "inherit" | "plaintext-only"

Optional contextMenu

contextMenu?: string

Optional controls

controls?: boolean

Optional coords

coords?: string

Optional crossOrigin

crossOrigin?: CrossOrigin

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. +

Optional aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

+

Optional as

as?: string

Optional async

async?: boolean

Optional autoCapitalize

autoCapitalize?: string

Non-standard Attributes

+

Optional autoComplete

autoComplete?: string

Optional autoCorrect

autoCorrect?: string

Optional autoFocus

autoFocus?: boolean

Optional autoPlay

autoPlay?: boolean

Optional autoSave

autoSave?: string

Optional capture

capture?: boolean | "user" | "environment"

Optional cellPadding

cellPadding?: string | number

Optional cellSpacing

cellSpacing?: string | number

Optional challenge

challenge?: string

Optional charSet

charSet?: string

Optional checked

checked?: boolean

Optional children

children?: ReactNode

Optional cite

cite?: string

Optional classID

classID?: string

Optional className

className?: string

Optional colSpan

colSpan?: number

Optional color

color?: string

Optional cols

cols?: number

Optional content

content?: string

Optional contentEditable

contentEditable?: Booleanish | "inherit" | "plaintext-only"

Optional contextMenu

contextMenu?: string

Optional controls

controls?: boolean

Optional coords

coords?: string

Optional crossOrigin

crossOrigin?: CrossOrigin

Optional dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. But unfortunately we're mixing renderer-specific type declarations.

    -

Optional data

data?: string

Optional datatype

datatype?: string

Optional dateTime

dateTime?: string

Optional default

default?: boolean

Optional defaultChecked

defaultChecked?: boolean

React-specific Attributes

-

Optional defaultValue

defaultValue?: string | number | readonly string[]

Optional defer

defer?: boolean

Optional dir

dir?: string

Optional disabled

disabled?: boolean

Optional download

download?: any

Optional draggable

draggable?: Booleanish

Optional encType

encType?: string

Optional forcedPages

forcedPages?: ForcedPage[]

Optional form

form?: string

Optional formAction

formAction?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional formEncType

formEncType?: string

Optional formMethod

formMethod?: string

Optional formNoValidate

formNoValidate?: boolean

Optional formTarget

formTarget?: string

Optional frameBorder

frameBorder?: string | number

Optional headers

headers?: string

Optional height

height?: string | number

Optional hidden

hidden?: boolean

Optional high

high?: number

Optional href

href?: string

Optional hrefLang

hrefLang?: string

Optional htmlFor

htmlFor?: string

Optional httpEquiv

httpEquiv?: string

Optional id

id?: string

Optional inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

-

Optional inlist

inlist?: any

Optional inputMode

inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

+

Optional data

data?: string

Optional datatype

datatype?: string

Optional dateTime

dateTime?: string

Optional default

default?: boolean

Optional defaultChecked

defaultChecked?: boolean

React-specific Attributes

+

Optional defaultValue

defaultValue?: string | number | readonly string[]

Optional defer

defer?: boolean

Optional dir

dir?: string

Optional disabled

disabled?: boolean

Optional download

download?: any

Optional draggable

draggable?: Booleanish

Optional encType

encType?: string

Optional forcedPages

forcedPages?: ForcedPage[]

Optional form

form?: string

Optional formAction

formAction?: string | ((formData) => void)

Type declaration

    • (formData): void

    • Parameters

      • formData: FormData

      Returns void

Optional formEncType

formEncType?: string

Optional formMethod

formMethod?: string

Optional formNoValidate

formNoValidate?: boolean

Optional formTarget

formTarget?: string

Optional frameBorder

frameBorder?: string | number

Optional headers

headers?: string

Optional height

height?: string | number

Optional hidden

hidden?: boolean

Optional high

high?: number

Optional href

href?: string

Optional hrefLang

hrefLang?: string

Optional htmlFor

htmlFor?: string

Optional httpEquiv

httpEquiv?: string

Optional id

id?: string

Optional inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

+

Optional inlist

inlist?: any

Optional inputMode

inputMode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

-

Optional integrity

integrity?: string

Optional is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

+

Optional integrity

integrity?: string

Optional is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

-

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional key

key?: null | Key

Optional keyParams

keyParams?: string

Optional keyType

keyType?: string

Optional kind

kind?: string

Optional label

label?: string

Optional lang

lang?: string

Optional list

list?: string

Optional loop

loop?: boolean

Optional low

low?: number

Optional manifest

manifest?: string

Optional marginHeight

marginHeight?: number

Optional marginWidth

marginWidth?: number

Optional max

max?: string | number

Optional maxLength

maxLength?: number

Optional media

media?: string

Optional mediaGroup

mediaGroup?: string

Optional method

method?: string

Optional min

min?: string | number

Optional minLength

minLength?: number

Optional multiple

multiple?: boolean

Optional muted

muted?: boolean

Optional name

name?: string

Optional noValidate

noValidate?: boolean

Optional nonce

nonce?: string

Optional onAbort

onAbort?: ReactEventHandler<HTMLElement>

Media Events

-

Optional onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLElement>

Optional onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLElement>

Optional onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

-

Optional onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLElement>

Optional onAuxClick

onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

-

Optional onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLElement>

Optional onBeforeInput

onBeforeInput?: FormEventHandler<HTMLElement>

Optional onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLElement>

Optional onBlur

onBlur?: FocusEventHandler<HTMLElement>

Optional onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLElement>

Optional onCanPlay

onCanPlay?: ReactEventHandler<HTMLElement>

Optional onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLElement>

Optional onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>

Optional onChange

onChange?: FormEventHandler<HTMLElement>

Form Events

-

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLElement>

Optional onClick

onClick?: MouseEventHandler<HTMLElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLElement>

Optional onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

-

Optional onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLElement>

Optional onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLElement>

Optional onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLElement>

Optional onCopy

onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

-

Optional onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLElement>

Optional onCut

onCut?: ClipboardEventHandler<HTMLElement>

Optional onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLElement>

Optional onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLElement>

Optional onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLElement>

Optional onDrag

onDrag?: DragEventHandler<HTMLElement>

Optional onDragCapture

onDragCapture?: DragEventHandler<HTMLElement>

Optional onDragEnd

onDragEnd?: DragEventHandler<HTMLElement>

Optional onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLElement>

Optional onDragEnter

onDragEnter?: DragEventHandler<HTMLElement>

Optional onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLElement>

Optional onDragExit

onDragExit?: DragEventHandler<HTMLElement>

Optional onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLElement>

Optional onDragLeave

onDragLeave?: DragEventHandler<HTMLElement>

Optional onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLElement>

Optional onDragOver

onDragOver?: DragEventHandler<HTMLElement>

Optional onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLElement>

Optional onDragStart

onDragStart?: DragEventHandler<HTMLElement>

Optional onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLElement>

Optional onDrop

onDrop?: DragEventHandler<HTMLElement>

Optional onDropCapture

onDropCapture?: DragEventHandler<HTMLElement>

Optional onDurationChange

onDurationChange?: ReactEventHandler<HTMLElement>

Optional onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLElement>

Optional onEmptied

onEmptied?: ReactEventHandler<HTMLElement>

Optional onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLElement>

Optional onEncrypted

onEncrypted?: ReactEventHandler<HTMLElement>

Optional onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLElement>

Optional onEnded

onEnded?: ReactEventHandler<HTMLElement>

Optional onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLElement>

Optional onError

onError?: ReactEventHandler<HTMLElement>

Optional onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLElement>

Optional onFocus

onFocus?: FocusEventHandler<HTMLElement>

Focus Events

-

Optional onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLElement>

Optional onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onInput

onInput?: FormEventHandler<HTMLElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLElement>

Optional onInvalid

onInvalid?: FormEventHandler<HTMLElement>

Optional onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

-

Optional onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLElement>

Optional onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLElement>

Optional onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLElement>

Optional onLoad

onLoad?: ReactEventHandler<HTMLElement>

Image Events

-

Optional onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLElement>

Optional onLoadStart

onLoadStart?: ReactEventHandler<HTMLElement>

Optional onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedData

onLoadedData?: ReactEventHandler<HTMLElement>

Optional onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>

Optional onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onMouseDown

onMouseDown?: MouseEventHandler<HTMLElement>

Optional onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLElement>

Optional onMouseMove

onMouseMove?: MouseEventHandler<HTMLElement>

Optional onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOut

onMouseOut?: MouseEventHandler<HTMLElement>

Optional onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLElement>

Optional onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLElement>

Optional onMouseUp

onMouseUp?: MouseEventHandler<HTMLElement>

Optional onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLElement>

Optional onPaste

onPaste?: ClipboardEventHandler<HTMLElement>

Optional onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLElement>

Optional onPause

onPause?: ReactEventHandler<HTMLElement>

Optional onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLElement>

Optional onPlay

onPlay?: ReactEventHandler<HTMLElement>

Optional onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLElement>

Optional onPlaying

onPlaying?: ReactEventHandler<HTMLElement>

Optional onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLElement>

Optional onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLElement>

Optional onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLElement>

Optional onPointerDown

onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

-

Optional onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLElement>

Optional onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLElement>

Optional onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLElement>

Optional onPointerMove

onPointerMove?: PointerEventHandler<HTMLElement>

Optional onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOut

onPointerOut?: PointerEventHandler<HTMLElement>

Optional onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOver

onPointerOver?: PointerEventHandler<HTMLElement>

Optional onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLElement>

Optional onPointerUp

onPointerUp?: PointerEventHandler<HTMLElement>

Optional onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLElement>

Optional onProgress

onProgress?: ReactEventHandler<HTMLElement>

Optional onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLElement>

Optional onRateChange

onRateChange?: ReactEventHandler<HTMLElement>

Optional onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLElement>

Optional onReset

onReset?: FormEventHandler<HTMLElement>

Optional onResetCapture

onResetCapture?: FormEventHandler<HTMLElement>

Optional onResize

onResize?: ReactEventHandler<HTMLElement>

Optional onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLElement>

Optional onScroll

onScroll?: UIEventHandler<HTMLElement>

UI Events

-

Optional onScrollCapture

onScrollCapture?: UIEventHandler<HTMLElement>

Optional onSeeked

onSeeked?: ReactEventHandler<HTMLElement>

Optional onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLElement>

Optional onSeeking

onSeeking?: ReactEventHandler<HTMLElement>

Optional onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLElement>

Optional onSelect

onSelect?: ReactEventHandler<HTMLElement>

Selection Events

-

Optional onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLElement>

Optional onStalled

onStalled?: ReactEventHandler<HTMLElement>

Optional onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLElement>

Optional onSubmit

onSubmit?: FormEventHandler<HTMLElement>

Optional onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLElement>

Optional onSuspend

onSuspend?: ReactEventHandler<HTMLElement>

Optional onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLElement>

Optional onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLElement>

Optional onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

-

Optional onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLElement>

Optional onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLElement>

Optional onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLElement>

Optional onTouchMove

onTouchMove?: TouchEventHandler<HTMLElement>

Optional onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLElement>

Optional onTouchStart

onTouchStart?: TouchEventHandler<HTMLElement>

Optional onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLElement>

Optional onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLElement>

Transition Events

-

Optional onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

-

Optional onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLElement>

Optional onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLElement>

Optional onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLElement>

Optional onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLElement>

Optional onWaiting

onWaiting?: ReactEventHandler<HTMLElement>

Optional onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLElement>

Optional onWheel

onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

-

Optional onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLElement>

Optional open

open?: boolean

Optional optimum

optimum?: number

Optional pattern

pattern?: string

Optional placeholder

placeholder?: string

Optional playsInline

playsInline?: boolean

Optional poster

poster?: string

Optional prefix

prefix?: string

Optional preload

preload?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Unknown

-

Optional readOnly

readOnly?: boolean

Optional ref

ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. +

Optional itemID

itemID?: string

Optional itemProp

itemProp?: string

Optional itemRef

itemRef?: string

Optional itemScope

itemScope?: boolean

Optional itemType

itemType?: string

Optional key

key?: null | Key

Optional keyParams

keyParams?: string

Optional keyType

keyType?: string

Optional kind

kind?: string

Optional label

label?: string

Optional lang

lang?: string

Optional list

list?: string

Optional loop

loop?: boolean

Optional low

low?: number

Optional manifest

manifest?: string

Optional marginHeight

marginHeight?: number

Optional marginWidth

marginWidth?: number

Optional max

max?: string | number

Optional maxLength

maxLength?: number

Optional media

media?: string

Optional mediaGroup

mediaGroup?: string

Optional method

method?: string

Optional min

min?: string | number

Optional minLength

minLength?: number

Optional multiple

multiple?: boolean

Optional muted

muted?: boolean

Optional name

name?: string

Optional noValidate

noValidate?: boolean

Optional nonce

nonce?: string

Optional onAbort

onAbort?: ReactEventHandler<HTMLElement>

Media Events

+

Optional onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLElement>

Optional onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLElement>

Optional onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLElement>

Optional onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>

Optional onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

+

Optional onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLElement>

Optional onAuxClick

onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

+

Optional onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLElement>

Optional onBeforeInput

onBeforeInput?: FormEventHandler<HTMLElement>

Optional onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLElement>

Optional onBlur

onBlur?: FocusEventHandler<HTMLElement>

Optional onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLElement>

Optional onCanPlay

onCanPlay?: ReactEventHandler<HTMLElement>

Optional onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLElement>

Optional onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLElement>

Optional onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>

Optional onChange

onChange?: FormEventHandler<HTMLElement>

Form Events

+

Optional onChangeCapture

onChangeCapture?: FormEventHandler<HTMLElement>

Optional onClick

onClick?: MouseEventHandler<HTMLElement>

Optional onClickCapture

onClickCapture?: MouseEventHandler<HTMLElement>

Optional onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

+

Optional onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLElement>

Optional onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLElement>

Optional onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLElement>

Optional onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLElement>

Optional onCopy

onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

+

Optional onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLElement>

Optional onCut

onCut?: ClipboardEventHandler<HTMLElement>

Optional onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLElement>

Optional onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLElement>

Optional onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLElement>

Optional onDrag

onDrag?: DragEventHandler<HTMLElement>

Optional onDragCapture

onDragCapture?: DragEventHandler<HTMLElement>

Optional onDragEnd

onDragEnd?: DragEventHandler<HTMLElement>

Optional onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLElement>

Optional onDragEnter

onDragEnter?: DragEventHandler<HTMLElement>

Optional onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLElement>

Optional onDragExit

onDragExit?: DragEventHandler<HTMLElement>

Optional onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLElement>

Optional onDragLeave

onDragLeave?: DragEventHandler<HTMLElement>

Optional onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLElement>

Optional onDragOver

onDragOver?: DragEventHandler<HTMLElement>

Optional onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLElement>

Optional onDragStart

onDragStart?: DragEventHandler<HTMLElement>

Optional onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLElement>

Optional onDrop

onDrop?: DragEventHandler<HTMLElement>

Optional onDropCapture

onDropCapture?: DragEventHandler<HTMLElement>

Optional onDurationChange

onDurationChange?: ReactEventHandler<HTMLElement>

Optional onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLElement>

Optional onEmptied

onEmptied?: ReactEventHandler<HTMLElement>

Optional onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLElement>

Optional onEncrypted

onEncrypted?: ReactEventHandler<HTMLElement>

Optional onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLElement>

Optional onEnded

onEnded?: ReactEventHandler<HTMLElement>

Optional onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLElement>

Optional onError

onError?: ReactEventHandler<HTMLElement>

Optional onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLElement>

Optional onFocus

onFocus?: FocusEventHandler<HTMLElement>

Focus Events

+

Optional onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLElement>

Optional onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLElement>

Optional onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onInput

onInput?: FormEventHandler<HTMLElement>

Optional onInputCapture

onInputCapture?: FormEventHandler<HTMLElement>

Optional onInvalid

onInvalid?: FormEventHandler<HTMLElement>

Optional onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

+

Optional onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLElement>

Optional onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLElement>

Optional onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLElement>

Optional onLoad

onLoad?: ReactEventHandler<HTMLElement>

Image Events

+

Optional onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLElement>

Optional onLoadStart

onLoadStart?: ReactEventHandler<HTMLElement>

Optional onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedData

onLoadedData?: ReactEventHandler<HTMLElement>

Optional onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLElement>

Optional onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>

Optional onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLElement>

Optional onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>

Optional onMouseDown

onMouseDown?: MouseEventHandler<HTMLElement>

Optional onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLElement>

Optional onMouseMove

onMouseMove?: MouseEventHandler<HTMLElement>

Optional onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOut

onMouseOut?: MouseEventHandler<HTMLElement>

Optional onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLElement>

Optional onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLElement>

Optional onMouseUp

onMouseUp?: MouseEventHandler<HTMLElement>

Optional onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLElement>

Optional onPaste

onPaste?: ClipboardEventHandler<HTMLElement>

Optional onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLElement>

Optional onPause

onPause?: ReactEventHandler<HTMLElement>

Optional onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLElement>

Optional onPlay

onPlay?: ReactEventHandler<HTMLElement>

Optional onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLElement>

Optional onPlaying

onPlaying?: ReactEventHandler<HTMLElement>

Optional onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLElement>

Optional onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLElement>

Optional onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLElement>

Optional onPointerDown

onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

+

Optional onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLElement>

Optional onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLElement>

Optional onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLElement>

Optional onPointerMove

onPointerMove?: PointerEventHandler<HTMLElement>

Optional onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOut

onPointerOut?: PointerEventHandler<HTMLElement>

Optional onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLElement>

Optional onPointerOver

onPointerOver?: PointerEventHandler<HTMLElement>

Optional onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLElement>

Optional onPointerUp

onPointerUp?: PointerEventHandler<HTMLElement>

Optional onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLElement>

Optional onProgress

onProgress?: ReactEventHandler<HTMLElement>

Optional onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLElement>

Optional onRateChange

onRateChange?: ReactEventHandler<HTMLElement>

Optional onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLElement>

Optional onReset

onReset?: FormEventHandler<HTMLElement>

Optional onResetCapture

onResetCapture?: FormEventHandler<HTMLElement>

Optional onResize

onResize?: ReactEventHandler<HTMLElement>

Optional onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLElement>

Optional onScroll

onScroll?: UIEventHandler<HTMLElement>

UI Events

+

Optional onScrollCapture

onScrollCapture?: UIEventHandler<HTMLElement>

Optional onSeeked

onSeeked?: ReactEventHandler<HTMLElement>

Optional onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLElement>

Optional onSeeking

onSeeking?: ReactEventHandler<HTMLElement>

Optional onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLElement>

Optional onSelect

onSelect?: ReactEventHandler<HTMLElement>

Selection Events

+

Optional onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLElement>

Optional onStalled

onStalled?: ReactEventHandler<HTMLElement>

Optional onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLElement>

Optional onSubmit

onSubmit?: FormEventHandler<HTMLElement>

Optional onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLElement>

Optional onSuspend

onSuspend?: ReactEventHandler<HTMLElement>

Optional onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLElement>

Optional onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLElement>

Optional onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLElement>

Optional onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

+

Optional onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLElement>

Optional onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLElement>

Optional onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLElement>

Optional onTouchMove

onTouchMove?: TouchEventHandler<HTMLElement>

Optional onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLElement>

Optional onTouchStart

onTouchStart?: TouchEventHandler<HTMLElement>

Optional onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLElement>

Optional onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLElement>

Transition Events

+

Optional onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

+

Optional onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLElement>

Optional onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLElement>

Optional onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLElement>

Optional onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLElement>

Optional onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLElement>

Optional onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLElement>

Optional onWaiting

onWaiting?: ReactEventHandler<HTMLElement>

Optional onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLElement>

Optional onWheel

onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

+

Optional onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLElement>

Optional open

open?: boolean

Optional optimum

optimum?: number

Optional pattern

pattern?: string

Optional placeholder

placeholder?: string

Optional playsInline

playsInline?: boolean

Optional poster

poster?: string

Optional prefix

prefix?: string

Optional preload

preload?: string

Optional property

property?: string

Optional radioGroup

radioGroup?: string

Unknown

+

Optional readOnly

readOnly?: boolean

Optional ref

ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See

React Docs

-

Optional rel

rel?: string

Optional required

required?: boolean

Optional resource

resource?: string

Optional results

results?: number

Optional rev

rev?: string

Optional reversed

reversed?: boolean

Optional role

role?: AriaRole

WAI-ARIA

-

Optional rowSpan

rowSpan?: number

Optional rows

rows?: number

Optional sandbox

sandbox?: string

Optional scope

scope?: string

Optional scoped

scoped?: boolean

Optional scrolling

scrolling?: string

Optional seamless

seamless?: boolean

Optional security

security?: string

Optional selected

selected?: boolean

Optional shape

shape?: string

Optional size

size?: number

Optional sizes

sizes?: string

Optional slot

slot?: string

Optional span

span?: number

Optional spellCheck

spellCheck?: Booleanish

Optional src

src?: string

Optional srcDoc

srcDoc?: string

Optional srcLang

srcLang?: string

Optional srcSet

srcSet?: string

Optional start

start?: number

Optional step

step?: string | number

Optional style

style?: CSSProperties

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optional summary

summary?: string

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional tabIndex

tabIndex?: number

Optional tag

tag?: keyof IntrinsicElements

Default Value

'html'
+

Optional rel

rel?: string

Optional required

required?: boolean

Optional resource

resource?: string

Optional results

results?: number

Optional rev

rev?: string

Optional reversed

reversed?: boolean

Optional role

role?: AriaRole

WAI-ARIA

+

Optional rowSpan

rowSpan?: number

Optional rows

rows?: number

Optional sandbox

sandbox?: string

Optional scope

scope?: string

Optional scoped

scoped?: boolean

Optional scrolling

scrolling?: string

Optional seamless

seamless?: boolean

Optional security

security?: string

Optional selected

selected?: boolean

Optional shape

shape?: string

Optional size

size?: number

Optional sizes

sizes?: string

Optional slot

slot?: string

Optional span

span?: number

Optional spellCheck

spellCheck?: Booleanish

Optional src

src?: string

Optional srcDoc

srcDoc?: string

Optional srcLang

srcLang?: string

Optional srcSet

srcSet?: string

Optional start

start?: number

Optional step

step?: string | number

Optional style

style?: CSSProperties

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optional summary

summary?: string

Optional suppressContentEditableWarning

suppressContentEditableWarning?: boolean

Optional suppressHydrationWarning

suppressHydrationWarning?: boolean

Optional tabIndex

tabIndex?: number

Optional tag

tag?: keyof IntrinsicElements

Default Value

'html'
-

Optional target

target?: string

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional type

type?: string

Optional typeof

typeof?: string

Optional unselectable

unselectable?: "on" | "off"

Optional useMap

useMap?: string

Optional value

value?: string | number | readonly string[]

Optional vocab

vocab?: string

Optional width

width?: string | number

Optional wmode

wmode?: string

Optional wrap

wrap?: string

Settings

Member Visibility

Theme

On This Page

aboutacceptacceptCharsetaccessKeyactionallowFullScreenallowTransparencyaltaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasasyncautoCapitalizeautoCompleteautoCorrectautoFocusautoPlayautoSavecapturecellPaddingcellSpacingchallengecharSetcheckedchildrenciteclassIDclassNamecolSpancolorcolscontentcontentEditablecontextMenucontrolscoordscrossOrigindangerouslySetInnerHTMLdatadatatypedateTimedefaultdefaultCheckeddefaultValuedeferdirdisableddownloaddraggableencTypeforcedPagesformformActionformEncTypeformMethodformNoValidateformTargetframeBorderheadersheighthiddenhighhrefhrefLanghtmlForhttpEquividinertinlistinputModeintegrityisitemIDitemPropitemRefitemScopeitemTypekeykeyParamskeyTypekindlabellanglistlooplowmanifestmarginHeightmarginWidthmaxmaxLengthmediamediaGroupmethodminminLengthmultiplemutednamenoValidatenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureopenoptimumpatternplaceholderplaysInlineposterprefixpreloadpropertyradioGroupreadOnlyrefrelrequiredresourceresultsrevreversedrolerowSpanrowssandboxscopescopedscrollingseamlesssecurityselectedshapesizesizesslotspanspellChecksrcsrcDocsrcLangsrcSetstartstepstylestylessummarysuppressContentEditableWarningsuppressHydrationWarningtabIndextagtargettargetIdtitletranslatetypetypeofunselectableuseMapvaluevocabwidthwmodewrap
\ No newline at end of file +

Optional target

target?: string

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Optional title

title?: string

Optional translate

translate?: "yes" | "no"

Optional type

type?: string

Optional typeof

typeof?: string

Optional unselectable

unselectable?: "on" | "off"

Optional useMap

useMap?: string

Optional value

value?: string | number | readonly string[]

Optional vocab

vocab?: string

Optional width

width?: string | number

Optional wmode

wmode?: string

Optional wrap

wrap?: string

Settings

Member Visibility

Theme

On This Page

aboutacceptacceptCharsetaccessKeyactionallowFullScreenallowTransparencyaltaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasasyncautoCapitalizeautoCompleteautoCorrectautoFocusautoPlayautoSavecapturecellPaddingcellSpacingchallengecharSetcheckedchildrenciteclassIDclassNamecolSpancolorcolscontentcontentEditablecontextMenucontrolscoordscrossOrigindangerouslySetInnerHTMLdatadatatypedateTimedefaultdefaultCheckeddefaultValuedeferdirdisableddownloaddraggableencTypeforcedPagesformformActionformEncTypeformMethodformNoValidateformTargetframeBorderheadersheighthiddenhighhrefhrefLanghtmlForhttpEquividinertinlistinputModeintegrityisitemIDitemPropitemRefitemScopeitemTypekeykeyParamskeyTypekindlabellanglistlooplowmanifestmarginHeightmarginWidthmaxmaxLengthmediamediaGroupmethodminminLengthmultiplemutednamenoValidatenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureopenoptimumpatternplaceholderplaysInlineposterprefixpreloadpropertyradioGroupreadOnlyrefrelrequiredresourceresultsrevreversedrolerowSpanrowssandboxscopescopedscrollingseamlesssecurityselectedshapesizesizesslotspanspellChecksrcsrcDocsrcLangsrcSetstartstepstylestylessummarysuppressContentEditableWarningsuppressHydrationWarningtabIndextagtargettargetIdtitletranslatetypetypeofunselectableuseMapvaluevocabwidthwmodewrap
\ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html index 62f8205f..b9fa8dea 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -client | Code Documentation

Module client

References

ColorSwitch +client | Code Documentation

Module client

References

ColorSwitch ColorSwitchProps DataProps ForceColorScheme diff --git a/docs/modules/client_color_switch.html b/docs/modules/client_color_switch.html index afdca6cc..9e0ecf25 100644 --- a/docs/modules/client_color_switch.html +++ b/docs/modules/client_color_switch.html @@ -1,3 +1,3 @@ -client/color-switch | Code Documentation

Module client/color-switch

References

ColorSwitch +client/color-switch | Code Documentation

Module client/color-switch

References

ColorSwitch ColorSwitchProps

References

ColorSwitch

Re-exports ColorSwitch

ColorSwitchProps

Re-exports ColorSwitchProps

Settings

Member Visibility

Theme

On This Page

ColorSwitchColorSwitchProps
\ No newline at end of file diff --git a/docs/modules/client_color_switch_color_switch.html b/docs/modules/client_color_switch_color_switch.html index e3157b55..438df5d1 100644 --- a/docs/modules/client_color_switch_color_switch.html +++ b/docs/modules/client_color_switch_color_switch.html @@ -1,3 +1,3 @@ -client/color-switch/color-switch | Code Documentation

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps +client/color-switch/color-switch | Code Documentation

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps

Functions

ColorSwitch

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/client_force_color_scheme.html b/docs/modules/client_force_color_scheme.html index 0727b5cf..2d756b10 100644 --- a/docs/modules/client_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme | Code Documentation

Module client/force-color-scheme

References

ForceColorScheme +client/force-color-scheme | Code Documentation

Module client/force-color-scheme

References

ForceColorScheme

References

ForceColorScheme

Re-exports ForceColorScheme

Settings

Member Visibility

Theme

On This Page

ForceColorScheme
\ No newline at end of file diff --git a/docs/modules/client_force_color_scheme_force_color_scheme.html b/docs/modules/client_force_color_scheme_force_color_scheme.html index 727a5a1c..f9c3adf7 100644 --- a/docs/modules/client_force_color_scheme_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme/force-color-scheme | Code Documentation

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme +client/force-color-scheme/force-color-scheme | Code Documentation

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/client_force_theme.html b/docs/modules/client_force_theme.html index 3b9c4f35..38538766 100644 --- a/docs/modules/client_force_theme.html +++ b/docs/modules/client_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme | Code Documentation

Module client/force-theme

References

ForceTheme +client/force-theme | Code Documentation

Module client/force-theme

References

ForceTheme

References

ForceTheme

Re-exports ForceTheme

Settings

Member Visibility

Theme

On This Page

ForceTheme
\ No newline at end of file diff --git a/docs/modules/client_force_theme_force_theme.html b/docs/modules/client_force_theme_force_theme.html index 42e246fa..dedf2e5b 100644 --- a/docs/modules/client_force_theme_force_theme.html +++ b/docs/modules/client_force_theme_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme/force-theme | Code Documentation

Module client/force-theme/force-theme

Index

Functions

ForceTheme +client/force-theme/force-theme | Code Documentation

Module client/force-theme/force-theme

Index

Functions

ForceTheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/client_theme_switcher.html b/docs/modules/client_theme_switcher.html index c43f6f45..36651f59 100644 --- a/docs/modules/client_theme_switcher.html +++ b/docs/modules/client_theme_switcher.html @@ -1,4 +1,4 @@ -client/theme-switcher | Code Documentation

Module client/theme-switcher

References

DataProps +client/theme-switcher | Code Documentation

Module client/theme-switcher

References

DataProps ThemeSwitcher ThemeSwitcherProps UpdateProps diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index b1308f74..2b682e01 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,4 +1,4 @@ -client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

DataProps +client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

DataProps ThemeSwitcherProps UpdateProps

Functions

ThemeSwitcher diff --git a/docs/modules/constants.html b/docs/modules/constants.html index c06a9427..391f4099 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | Code Documentation

Module constants

Index

Interfaces

ThemeStoreType +constants | Code Documentation

Module constants

Index

Interfaces

ThemeStoreType

Type Aliases

ColorSchemeType ThemeStoreActionsType

Variables

DEFAULT_ID diff --git a/docs/modules/hooks.html b/docs/modules/hooks.html index dc143ff6..6e77ec67 100644 --- a/docs/modules/hooks.html +++ b/docs/modules/hooks.html @@ -1,2 +1,2 @@ -hooks | Code Documentation

Module hooks

References

useTheme +hooks | Code Documentation

Module hooks

References

useTheme

References

useTheme

Re-exports useTheme

Settings

Member Visibility

Theme

On This Page

useTheme
\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 008ede73..e321cb54 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,2 +1,2 @@ -hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Functions

useTheme +hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Functions

useTheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html b/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html index a3df5d06..8491b794 100644 --- a/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html +++ b/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html @@ -1,4 +1,4 @@ -server/nextjs/server-side-wrapper/server-side-wrapper | Code Documentation

Module server/nextjs/server-side-wrapper/server-side-wrapper

References

NextJsServerTarget +server/nextjs/server-side-wrapper/server-side-wrapper | Code Documentation

Module server/nextjs/server-side-wrapper/server-side-wrapper

References

NextJsServerTarget

Interfaces

NextJsSSRThemeSwitcherProps ServerSideWrapperProps

Type Aliases

ForcedPage diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 082594ba..50f66b34 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,4 +1,4 @@ -utils | Code Documentation

Module utils

Index

Functions

encodeState +utils | Code Documentation

Module utils

Index

Functions

encodeState getResolvedColorScheme getResolvedTheme parseState diff --git a/docs/types/constants.ColorSchemeType.html b/docs/types/constants.ColorSchemeType.html index 058b81a2..563ac64d 100644 --- a/docs/types/constants.ColorSchemeType.html +++ b/docs/types/constants.ColorSchemeType.html @@ -1 +1 @@ -ColorSchemeType | Code Documentation

Type alias ColorSchemeType

ColorSchemeType: "" | "system" | "dark" | "light"

Settings

Member Visibility

Theme

\ No newline at end of file +ColorSchemeType | Code Documentation

Type alias ColorSchemeType

ColorSchemeType: "" | "system" | "dark" | "light"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/constants.ThemeStoreActionsType.html b/docs/types/constants.ThemeStoreActionsType.html index f4eaf57a..0e9c1f31 100644 --- a/docs/types/constants.ThemeStoreActionsType.html +++ b/docs/types/constants.ThemeStoreActionsType.html @@ -1 +1 @@ -ThemeStoreActionsType | Code Documentation

Type alias ThemeStoreActionsType

ThemeStoreActionsType: {
    setColorSchemePref: ((colorSchemePref) => void);
    setDarkTheme: ((darkTheme) => void);
    setForcedColorScheme: ((forcedColorScheme?) => void);
    setForcedTheme: ((forcedTheme?) => void);
    setLightTheme: ((lightTheme) => void);
    setTheme: ((theme) => void);
    setThemeSet: ((themeSet) => void);
}

Type declaration

  • setColorSchemePref: ((colorSchemePref) => void)
      • (colorSchemePref): void

      • Parameters

        Returns void

  • setDarkTheme: ((darkTheme) => void)
      • (darkTheme): void

      • Parameters

        • darkTheme: string

        Returns void

  • setForcedColorScheme: ((forcedColorScheme?) => void)
      • (forcedColorScheme?): void

      • Parameters

        Returns void

  • setForcedTheme: ((forcedTheme?) => void)
      • (forcedTheme?): void

      • Parameters

        • Optional forcedTheme: string

        Returns void

  • setLightTheme: ((lightTheme) => void)
      • (lightTheme): void

      • Parameters

        • lightTheme: string

        Returns void

  • setTheme: ((theme) => void)
      • (theme): void

      • Parameters

        • theme: string

        Returns void

  • setThemeSet: ((themeSet) => void)
      • (themeSet): void

      • Parameters

        • themeSet: {
              darkTheme: string;
              lightTheme: string;
          }
          • darkTheme: string
          • lightTheme: string

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +ThemeStoreActionsType | Code Documentation

Type alias ThemeStoreActionsType

ThemeStoreActionsType: {
    setColorSchemePref: ((colorSchemePref) => void);
    setDarkTheme: ((darkTheme) => void);
    setForcedColorScheme: ((forcedColorScheme?) => void);
    setForcedTheme: ((forcedTheme?) => void);
    setLightTheme: ((lightTheme) => void);
    setTheme: ((theme) => void);
    setThemeSet: ((themeSet) => void);
}

Type declaration

  • setColorSchemePref: ((colorSchemePref) => void)
      • (colorSchemePref): void

      • Parameters

        Returns void

  • setDarkTheme: ((darkTheme) => void)
      • (darkTheme): void

      • Parameters

        • darkTheme: string

        Returns void

  • setForcedColorScheme: ((forcedColorScheme?) => void)
      • (forcedColorScheme?): void

      • Parameters

        Returns void

  • setForcedTheme: ((forcedTheme?) => void)
      • (forcedTheme?): void

      • Parameters

        • Optional forcedTheme: string

        Returns void

  • setLightTheme: ((lightTheme) => void)
      • (lightTheme): void

      • Parameters

        • lightTheme: string

        Returns void

  • setTheme: ((theme) => void)
      • (theme): void

      • Parameters

        • theme: string

        Returns void

  • setThemeSet: ((themeSet) => void)
      • (themeSet): void

      • Parameters

        • themeSet: {
              darkTheme: string;
              lightTheme: string;
          }
          • darkTheme: string
          • lightTheme: string

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html b/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html index 7b48a7b1..c0dc9f47 100644 --- a/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html +++ b/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html @@ -1 +1 @@ -ForcedPage | Code Documentation

Type alias ForcedPage

ForcedPage: {
    pathMatcher: RegExp | string;
    props: {
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
    };
} | [pathMatcher: RegExp | string, themes: {
    colorScheme?: ColorSchemeType;
    theme?: string;
}]

Type declaration

  • pathMatcher: RegExp | string
  • props: {
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
    }

Settings

Member Visibility

Theme

\ No newline at end of file +ForcedPage | Code Documentation

Type alias ForcedPage

ForcedPage: {
    pathMatcher: RegExp | string;
    props: {
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
    };
} | [pathMatcher: RegExp | string, themes: {
    colorScheme?: ColorSchemeType;
    theme?: string;
}]

Type declaration

  • pathMatcher: RegExp | string
  • props: {
        forcedColorScheme?: ColorSchemeType;
        forcedTheme?: string;
    }

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index 52fac647..1bc48abf 100644 --- a/docs/variables/constants.DEFAULT_ID.html +++ b/docs/variables/constants.DEFAULT_ID.html @@ -1,2 +1,2 @@ DEFAULT_ID | Code Documentation

Variable DEFAULT_IDConst

DEFAULT_ID: "nth" = "nth"

shared constants -- keep in separate files for better tree-shaking and dependency injection

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/constants.initialState.html b/docs/variables/constants.initialState.html index e810bd97..7a112140 100644 --- a/docs/variables/constants.initialState.html +++ b/docs/variables/constants.initialState.html @@ -1 +1 @@ -initialState | Code Documentation

Variable initialStateConst

initialState: ThemeStoreType = ...

Settings

Member Visibility

Theme

\ No newline at end of file +initialState | Code Documentation

Variable initialStateConst

initialState: ThemeStoreType = ...

Settings

Member Visibility

Theme

\ No newline at end of file