Class Registry

A helper class for use in the browser globals context to register any of the following:

String bundles
Layout components
Custom commands
Component factories

export
class: Registry

Hierarchy

Registry

Index

Methods

Methods

Static registerCommand

registerCommand(name: string, cmdDef: ICommand | IInvokeUrlCommand | ISearchCommand): void

Registers the given command with the given name

static

memberof

Registry

Parameters
- name: string
  
  The name of the command
- cmdDef: ICommand | IInvokeUrlCommand | ISearchCommand
  
  The command to register
Returns void

Static registerComponentFactory

registerComponentFactory(id: string, factory: function): void

Registers the given JSX element factory for the given component id

static

memberof

Registry

Parameters
- id: string
  
  The component id
- factory: function
  
  The JSX element factory that creates the component
  - - (props: any): Element
    - Parameters
      - props: any
      Returns Element
Returns void

Static registerLayout

registerLayout(name: string, factory: function): void

Registers the given JSX element factory for the given viewer template name

static

memberof

Registry

Parameters
- name: string
  
  The viewer template name
- factory: function
  
  The JSX element factory that creates the viewer template component
  - - (): Element
    - Returns Element
Returns void

Static registerStringBundle

registerStringBundle(locale: string, bundle: any): void

Registers the given string bundle under the given locale

static

memberof

Registry

Parameters
- locale: string
  
  The locale
- bundle: any
  
  The string bundle
Returns void

Generated using TypeDoc