OptionsFeature

This page is a reference to the OptionsFeature used in the `embed-dossier-mstr-react` library.

Interface Definition

export interface OptionsFeature {
  enabled?: boolean
  help?: boolean
  logout?: boolean
  manage?: boolean
  showLibraries?: boolean
  showTutorials?: boolean
  preferences?: boolean
}

Properties

PropertyTypeDefaultDescription
enabledbooleanundefinedDetermines whether the options menu is enabled in the navigation bar.
helpbooleanundefinedControls the visibility of the help option in the options menu.
logoutbooleanundefinedControls the visibility of the logout option in the options menu.
managebooleanundefinedControls the visibility of the manage option in the options menu.
showLibrariesbooleanundefinedControls the visibility of the show libraries option in the options menu.
showTutorialsbooleanundefinedControls the visibility of the show tutorials option in the options menu.
preferencesbooleanundefinedControls the visibility of the preferences option in the options menu.

Usage Example

import { useMstrEmbedConfig } from "embed-dossier-mstr-react"

const MyDossierComponent = () => {
  const config = useMstrEmbedConfig({
    optionsFeature: {
      enabled: true,
      help: true,
      logout: false,
      manage: true,
      showLibraries: false,
      showTutorials: false,
      preferences: true,
    },
  })

  return <div>{/* Your component using the config */}</div>
}