API

<gem-book> API

Extends GemElement

Constructor GemBookElement()

Params Type
config BookConfig
customTheme Partial<Theme>

Static Properties

Property Type
GemBookPluginElement any

Instance Properties

Property(Attribute) Reactive Type
src(src) Yes string
dev(dev) Yes boolean
config Yes BookConfig | undefined
theme Yes Partial<Theme> | undefined
routechange Emitter<null>
changeTheme any
routeRef any

Other

Type Value
Event routechange
Slot sidebar-before, main-before, main-after, nav-inside, logo-after
Part nav, sidebar, main, edit-link, rel-link, footer, homepage-hero, sidebar-content, sidebar-logo
CSS State is-home-page, render-full-width

<gem-book-plugin> API

Extends GemElement

Static Properties

Property Type
Gem any
Utils { escapeHTML: any; capitalize: any; debounce: any; throttle: any; getRanges: any; getParts: any; getRemoteURL: typeof getRemoteURL; parseMarkdown: any; unsafeRenderHTML: any; isGitLab: any; }
caches Map<typeof import("/src/element/elements/plugin").GemBookPluginElement, Map<string, any>>
theme any
themeStore any
icons any
selfI18n any
originDocLang any
mediaQuery any
locationStore any
config any
get links any
get nav any
get routes any
get lang any
get langList any
get homePage any
get currentSidebar any
get currentLinks any
get devMode any
get currentLink any

Instance Properties

Property(Attribute) Reactive Type
error Emitter<ErrorEvent | Event>

Instance Methods

Method Type
cacheState (this: any, getDeps: () => (string | number)[]) => void

Other

Type Value
Event error