Class DeckPageHero<CustomAttrs>

Introduces the page, like the Messages page's hero, and can be dismissed for good, like core's WelcomeHero.

Type Parameters

CustomAttrs extends IDeckPageHeroAttrs = IDeckPageHeroAttrs

Hierarchy (View Summary)

Hero<CustomAttrs>
- DeckPageHero

Index

Constructors

Methods

bodyItems className contentItems hide view isHidden

Constructors

constructor

new DeckPageHero<
CustomAttrs extends IDeckPageHeroAttrs<CustomAttrs> = IDeckPageHeroAttrs,
>(): DeckPageHero<CustomAttrs>
Type Parameters
- CustomAttrs extends IDeckPageHeroAttrs<CustomAttrs> = IDeckPageHeroAttrs
Returns DeckPageHero<CustomAttrs>
Inherited from Hero.constructor

Methods

bodyItems

bodyItems(): ItemList<Children>
Defines the child elements that will be rendered within the main container of the hero. Subclasses MUST implement this method to define the specific content of the hero.

Returns ItemList<Children>
Example
```
bodyItems(): ItemList<Mithril.Children> {
  const items = new ItemList<Mithril.Children>();
  items.add('title', <h1>Welcome!</h1>);
  return items;
}
```
Overrides Hero.bodyItems
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:38

className

className(): string
Defines the primary CSS class name for the hero component's root element. Subclasses MUST implement this method to provide a specific class name.

Returns string
Example
```
className(): string {
 return 'FoobarHero';
}
```
Overrides Hero.className
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:28

contentItems

contentItems(): ItemList<Children>
Returns ItemList<Children>
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:57

hide

hide(): void
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:73

view

view(): Element | null
Renders the hero component. This method constructs the root element with the appropriate class names and styles. It then calls viewItems() to render the content of the hero.

Returns Element | null
Overrides Hero.view
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:32

`Static`isHidden

isHidden(): boolean
Remembered per browser, as core's welcome hero is.

Returns boolean
- Defined in extensions/deck/js/src/forum/components/DeckPageHero.tsx:20