Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModuleDefinition

Hierarchy

  • ModuleDefinition

Index

Properties

Optional fullName

fullName: undefined | string

Optional homepage

homepage: undefined | string

Optionnaly specify a link to your page or github repo

Optional menuIcon

menuIcon: undefined | string

An icon to display next to the name, if none is specified, it will receive a default one

Optional menuText

menuText: undefined | string

The name displayed on the menu

Optional moduleView

moduleView: ModuleViewOptions

Additional options that can be applied to the module's view

name

name: string

This name should be in lowercase and without special characters (only - and _)

Optional noInterface

noInterface: undefined | false | true

If set to true, no menu item will be displayed

Optional plugins

Generated using TypeDoc