Class DeckPage<CustomAttrs>

The Page component

Type Parameters

CustomAttrs extends IDeckPageAttrs = IDeckPageAttrs

Hierarchy (View Summary)

Page<CustomAttrs>
- DeckPage

Constructors

constructor

new DeckPage<CustomAttrs extends IDeckPageAttrs = IDeckPageAttrs>(): DeckPage<
CustomAttrs,
>
Type Parameters
- CustomAttrs extends IDeckPageAttrs = IDeckPageAttrs
Returns DeckPage<CustomAttrs>
Inherited from Page.constructor

Properties

`Protected`activeIndex

activeIndex: number = 0

The column filling the screen in the phone layout.

`Protected`chipSortable

chipSortable: Sortable | null = null

`Protected`deck

deck: DeckState

`Protected`fullscreen

fullscreen: boolean = ...

Just the deck: the forum's header, nav and the hero out of the way.

`Protected`heroDismissed

heroDismissed: boolean = ...

Once the hero is gone the toolbar names the page instead.

`Protected`media

media: MediaQueryList[] = []

`Protected`observer

observer: IntersectionObserver | null = null

`Protected`sortable

sortable: typeof Sortable | null = null

Methods

actionItems

actionItems(): ItemList<Children>
Returns ItemList<Children>
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:256

`Protected`addButton

addButton(): Children
Returns Children
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:340

`Protected`columnFor

columnFor(element: HTMLElement): DeckColumnState | undefined
Parameters
- element: HTMLElement
Returns DeckColumnState | undefined
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:445

isFullscreen

isFullscreen(): boolean
Returns boolean
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:55

`Protected`isPhone

isPhone(): boolean
Returns boolean
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:427

`Protected`isShort

isShort(): boolean
Returns boolean
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:431

`Protected`newDiscussionButton

newDiscussionButton(): Children
As the side nav's, which the deck keeps for the same reason. See DeckSidebar.

Returns Children
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:321

`Protected`observeColumns

observeColumns(): void
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:441

oncreate

oncreate(vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>): void
Parameters
- vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>
Returns void
Inherit Doc
Overrides Page.oncreate
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:107

oninit

oninit(vnode: Vnode<CustomAttrs, DeckPage<CustomAttrs>>): void
Parameters
- vnode: Vnode<CustomAttrs, DeckPage<CustomAttrs>>
Returns void
Inherit Doc
Overrides Page.oninit
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:78

onKeyDown

onKeyDown(e: KeyboardEvent): void
Escape leaves full screen, once nothing above the page (a modal) wants it.
Parameters
- e: KeyboardEvent
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:74

`Protected`onLayoutChange

onLayoutChange(): void
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:416

onremove

onremove(vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>): void
Parameters
- vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>
Returns void
Inherit Doc
Overrides Page.onremove
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:151

onupdate

onupdate(vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>): void
Parameters
- vnode: VnodeDOM<CustomAttrs, DeckPage<CustomAttrs>>
Returns void
Inherit Doc
Overrides Page.onupdate
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:144

`Protected`openAddColumn

openAddColumn(): void
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:357

optionItems

optionItems(): ItemList<Children>
The deck-wide actions in the toolbar's menu.

Returns ItemList<Children>
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:298

`Protected`phoneQuery

phoneQuery(): string
Core's phone breakpoint, read from its CSS variable so themes that move it are followed.

Returns string
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:421

`Protected`row

row(
    key: string,
    row: number | null,
    columns: DeckColumnState[],
    phone: boolean,
    grow?: number,
): Children
Parameters
- key: string
- row: number | null
- columns: DeckColumnState[]
- phone: boolean
- Optionalgrow: number
Returns Children
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:231

`Protected`rows

rows(): Children[]
Both rows, with a divider to share the height once each has a column.

Returns Children[]
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:220

`Protected`scrollToColumn

scrollToColumn(id: string): void
Parameters
- id: string
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:435

setFullscreen

setFullscreen(on: boolean): void
Parameters
- on: boolean
Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:59

`Protected`setUpChipSortable

setUpChipSortable(): void
On phones, chips are dragged to reorder (after a short press, so a tap still switches).

Returns void
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:388

`Protected`tabs

tabs(columns: DeckColumnState[], phone: boolean): Children
A chip per column with its pending count: on phones the way to switch (and, dragged, to reorder) columns; elsewhere a way to jump to columns scrolled out of sight.
Parameters
- columns: DeckColumnState[]
- phone: boolean
Returns Children
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:369

view

view(): Element
Returns Element
Inherit Doc
Overrides Page.view
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:165

`Static`storedFullscreen

storedFullscreen(): boolean
Returns boolean
- Defined in extensions/deck/js/src/forum/components/DeckPage.tsx:47