CustomUi

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

Interface Definition

export interface CustomUi {
  library?: LibraryUI
  reportConsumption?: ReportConsumptionUI
  dossierConsumption?: DossierConsumptionUI
  botConsumption?: BotConsumptionUI
  dossierAuthoring?: DossierAuthoringUI
}

Properties

library

Configuration options for the library interface.

library?: {
  navigationBar?: {
    enabled?: boolean;
    sortAndFilter?: boolean;
    title?: boolean;
    searchBar?: boolean;
    createNew?: {
      enabled?: boolean;
    };
    notification?: boolean;
    multiSelect?: {
      enabled?: boolean;
    };
    account?: {
      enabled?: boolean;
    };
    user?: {
      enabled?: boolean;
    };
  };
  sidebar?: {
    enabled?: boolean;
    show?: boolean;
  };
}
PropertyTypeDescription
navigationBar.enabledbooleanEnables or disables the entire navigation bar in the library interface.
navigationBar.sortAndFilterbooleanControls visibility of sort and filter options.
navigationBar.titlebooleanControls visibility of the title element.
navigationBar.searchBarbooleanControls visibility of the search bar.
navigationBar.createNew.enabledbooleanControls visibility of the "Create New" button.
navigationBar.notificationbooleanControls visibility of notification elements.
navigationBar.multiSelect.enabledbooleanControls ability to select multiple items.
navigationBar.account.enabledbooleanControls visibility of account-related elements.
navigationBar.user.enabledbooleanControls visibility of user-related elements.
sidebar.enabledbooleanEnables or disables the sidebar.
sidebar.showbooleanControls whether the sidebar is initially shown.

reportConsumption

Configuration options for report consumption interface.

reportConsumption?: {
  enabled?: boolean;
  goToLibrary?: boolean;
  pageBy?: boolean;
  reset?: boolean;
  reExecute?: boolean;
  filter?: boolean;
  rePrompt?: boolean;
  account?: {
    enabled?: boolean;
  };
  share?: {
    enabled?: boolean;
  };
}
PropertyTypeDescription
enabledbooleanEnables or disables the entire report consumption interface.
goToLibrarybooleanControls visibility of the "Go to Library" option.
pageBybooleanControls visibility of pagination options.
resetbooleanControls visibility of the reset functionality.
reExecutebooleanControls visibility of the re-execute functionality.
filterbooleanControls visibility of filter options.
rePromptbooleanControls visibility of re-prompt options.
account.enabledbooleanControls visibility of account options.
share.enabledbooleanControls visibility of sharing options.

dossierConsumption

Configuration options for dossier consumption interface.

dossierConsumption?: {
  navigationBar?: {
    enabled?: boolean;
    goToLibrary?: boolean;
    title?: boolean;
    toc?: boolean;
    reset?: boolean;
    reprompt?: boolean;
    share?: boolean;
    comment?: boolean;
    notification?: boolean;
    filter?: boolean;
    options?: boolean;
    bookmark?: boolean;
    undoRedo?: boolean;
    search?: boolean;
    edit?: boolean;
    dockedToc?: {
      isOpen?: boolean;
      isDocked?: boolean;
    };
  };
}
PropertyTypeDescription
navigationBar.enabledbooleanEnables or disables the navigation bar in dossier consumption.
navigationBar.goToLibrarybooleanControls visibility of the "Go to Library" option.
navigationBar.titlebooleanControls visibility of the title element.
navigationBar.tocbooleanControls visibility of the table of contents.
navigationBar.resetbooleanControls visibility of the reset functionality.
navigationBar.repromptbooleanControls visibility of reprompt options.
navigationBar.sharebooleanControls visibility of sharing options.
navigationBar.commentbooleanControls visibility of commenting functionality.
navigationBar.notificationbooleanControls visibility of notification elements.
navigationBar.filterbooleanControls visibility of filter options.
navigationBar.optionsbooleanControls visibility of options menu.
navigationBar.bookmarkbooleanControls visibility of bookmark functionality.
navigationBar.undoRedobooleanControls visibility of undo/redo functionality.
navigationBar.searchbooleanControls visibility of search functionality.
navigationBar.editbooleanControls visibility of edit functionality.
navigationBar.dockedToc.isOpenbooleanControls whether the table of contents is initially open.
navigationBar.dockedToc.isDockedbooleanControls whether the table of contents is docked.

botConsumption

Configuration options for bot consumption interface.

botConsumption?: {
  aiBot?: {
    titleBar?: {
      enabled?: boolean;
    };
    snapshotPanel?: {
      enabled?: boolean;
    };
    topicsPanel?: {
      enabled?: boolean;
    };
    chatPanel?: {
      showClearHistory?: boolean;
      showGiveTopics?: boolean;
      showWelcomePageBotImg?: boolean;
      showCopyBtn?: boolean;
      shouldLoadHistory?: boolean;
      shouldSaveToHistory?: boolean;
    };
  };
  navigationBar?: {
    enabled?: boolean;
  };
}
PropertyTypeDescription
aiBot.titleBar.enabledbooleanControls visibility of the title bar in the AI bot interface.
aiBot.snapshotPanel.enabledbooleanControls visibility of the snapshot panel.
aiBot.topicsPanel.enabledbooleanControls visibility of the topics panel.
aiBot.chatPanel.showClearHistorybooleanControls visibility of the clear history option in chat.
aiBot.chatPanel.showGiveTopicsbooleanControls visibility of the give topics option.
aiBot.chatPanel.showWelcomePageBotImgbooleanControls visibility of the bot image on welcome page.
aiBot.chatPanel.showCopyBtnbooleanControls visibility of the copy button in chat.
aiBot.chatPanel.shouldLoadHistorybooleanControls whether chat history should be loaded.
aiBot.chatPanel.shouldSaveToHistorybooleanControls whether chat should be saved to history.
navigationBar.enabledbooleanControls visibility of the navigation bar in bot consumption.

dossierAuthoring

Configuration options for dossier authoring interface.

dossierAuthoring?: {
  toolbar?: {
    tableOfContents?: { visible?: boolean; };
    undo?: { visible?: boolean; };
    redo?: { visible?: boolean; };
    refresh?: { visible?: boolean; };
    save?: { visible?: boolean; };
    more?: { visible?: boolean; };
    nlp?: { visible?: boolean; };
    freeformLayout?: { visible?: boolean; };
    pauseDataRetrieval?: { visible?: boolean; };
    dividerLeft?: { visible?: boolean; };
    dividerRight?: { visible?: boolean; };
    addData?: { visible?: boolean; };
    addChapter?: { visible?: boolean; };
    addPage?: { visible?: boolean; };
    insertVisualization?: { visible?: boolean; };
    insertFilter?: { visible?: boolean; };
    insertText?: { visible?: boolean; };
    insertImage?: { visible?: boolean; };
    insertHtml?: { visible?: boolean; };
    insertShape?: { visible?: boolean; };
    insertStack?: { visible?: boolean; };
    insertInfoWindow?: { visible?: boolean; };
    responsiveViewEditor?: { visible?: boolean; };
    responsivePreview?: { visible?: boolean; };
  };
  menubar?: {
    library?: { visible?: boolean; };
  };
}
PropertyTypeDescription
toolbar.tableOfContents.visiblebooleanControls visibility of the table of contents in the toolbar.
toolbar.undo.visiblebooleanControls visibility of the undo button.
toolbar.redo.visiblebooleanControls visibility of the redo button.
toolbar.refresh.visiblebooleanControls visibility of the refresh button.
toolbar.save.visiblebooleanControls visibility of the save button.
toolbar.more.visiblebooleanControls visibility of the more options button.
toolbar.nlp.visiblebooleanControls visibility of NLP (Natural Language Processing) features.
toolbar.freeformLayout.visiblebooleanControls visibility of freeform layout options.
toolbar.pauseDataRetrieval.visiblebooleanControls visibility of the pause data retrieval option.
toolbar.dividerLeft.visiblebooleanControls visibility of the left divider.
toolbar.dividerRight.visiblebooleanControls visibility of the right divider.
toolbar.addData.visiblebooleanControls visibility of the add data option.
toolbar.addChapter.visiblebooleanControls visibility of the add chapter option.
toolbar.addPage.visiblebooleanControls visibility of the add page option.
toolbar.insertVisualization.visiblebooleanControls visibility of the insert visualization option.
toolbar.insertFilter.visiblebooleanControls visibility of the insert filter option.
toolbar.insertText.visiblebooleanControls visibility of the insert text option.
toolbar.insertImage.visiblebooleanControls visibility of the insert image option.
toolbar.insertHtml.visiblebooleanControls visibility of the insert HTML option.
toolbar.insertShape.visiblebooleanControls visibility of the insert shape option.
toolbar.insertStack.visiblebooleanControls visibility of the insert stack option.
toolbar.insertInfoWindow.visiblebooleanControls visibility of the insert info window option.
toolbar.responsiveViewEditor.visiblebooleanControls visibility of the responsive view editor.
toolbar.responsivePreview.visiblebooleanControls visibility of the responsive preview option.
menubar.library.visiblebooleanControls visibility of the library option in the menubar.

Usage Example

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

const MyDossierComponent = () => {
  const config = useMstrEmbedConfig({
    customUi: {
      dossierConsumption: {
        navigationBar: {
          enabled: true,
          title: true,
          toc: true,
          share: true,
          filter: false,
          options: true,
          dockedToc: {
            isOpen: true,
            isDocked: true,
          },
        },
      },
    },
  })

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