Class InstanceAPI

constructor

• new InstanceAPI(element, configs?, options?): InstanceAPI

• Parameters

  • element: HTMLElement
  • Optionalconfigs: RampConfigs
  • Optionaloptions: RampOptions

  Returns InstanceAPI

Readonly$element

Readonly$i18n

Readonly$rootEl

Readonly$vApp

Readonlydev

Readonlyevent

Readonlyfixture

Readonlygeo

Readonlynotify

Readonlypanel

startRequired

Readonlyui

animate

• get animate(): boolean

• The current animation status.

  Returns boolean

  Memberof

  InstanceAPI

isFullscreen

• get isFullscreen(): boolean

• Whether the app is fullscreen.

  Returns boolean

  Memberof

  InstanceAPI

keyboardNav

• get keyboardNav(): undefined | KeyboardnavAPI

• Provides access to the keyboard navigation API if the fixture is available.

  Returns undefined | KeyboardnavAPI

language

• get language(): string

• The current locale string for the app.

  Returns string

  Memberof

  InstanceAPI

screenSize

• get screenSize(): null | string

• The 'screen' size for the app. Returns the largest screen class on the element; 'lg', 'md', 'sm' or 'xs'.

  Returns null | string

  Memberof

  InstanceAPI

started

• get started(): boolean

• Whether the app has been started.

  Returns boolean

  Memberof

  InstanceAPI

component

• component(id): any

• Retrieves a global Vue component by its id.

  Parameters

  • id: string

  Returns any

  Memberof

  InstanceAPI

• component<VC>(id, vueConstructor): VC

• Registers a global Vue component given an id and a constructor.

  Type Parameters

  • VC extends DefineComponent

  Parameters

  • id: string
  • vueConstructor: any

  Returns VC

  Memberof

  InstanceAPI

containsValidHtml

• containsValidHtml(content): boolean

• Return whether the string contains valid html content (i.e. a html element with opening and closing tags)

  Parameters

  • content: string

  Returns boolean

getConfig

• getConfig(): RampConfig

• Gets the [cloned] config linked to the current language of the app.

  Returns RampConfig

  Memberof

  InstanceAPI

reload

• reload(configs?, options?): void

• Reloads Vue R4MP instance, with the option of providing a new config

  Parameters

  • Optionalconfigs: RampConfigs

    language-keyed R4MP config. if missing, the existing configs will be used
  • Optionaloptions: RampOptions

    startup options for this R4MP instance

  Returns void

representsObject

• representsObject(content): boolean

• Return whether the string represents an object or array

  Parameters

  • content: string

  Returns boolean

scrollToInstance

• scrollToInstance(): void

• If scrollToInstance is set to true in the configuration file, scrolls the browser to this RAMP component.

  Returns void

  Memberof

  InstanceAPI

setLanguage

• setLanguage(language): void

• Sets the language of the app to the specified string (e.g. 'en' or 'fr').

  Parameters

  • language: string

    The locale string to switch to

  Returns void

  Memberof

  InstanceAPI

start

• start(): void

• Returns void

toggleFullscreen

• toggleFullscreen(): void

• Toggles fullscreen for the app.

  Returns void

  Memberof

  InstanceAPI

updateAlert

• updateAlert(alert): void

• Updates the screen reader alert. Use this to inform screen reader users of visual changes in the app (pieces of ui appearing/leaving).

  Parameters

  • alert: string

    the alert to make available to screen readers

  Returns void

  Memberof

  InstanceAPI

useStore

• useStore<T>(id): undefined | Readonly<T>

• Returns the pinia store of the specified id, if it exists, else returns undefined.

  Type Parameters

  • T

  Parameters

  • id: string

    the id of the store to return

  Returns undefined | Readonly<T>

  Memberof

  InstanceAPI