Skip to main content

UserPreferences

To install, run yarn template UserPreferences

User preferences are developer-defined options that give users the ability to fine-tune their Finsemble experience. The end user can only modify what you give them access to. By default, Finsemble allows users to set these preferences:

The UserPreferences component template provides four nav sections by default:

const sections = {
General: General,
Workspaces: Workspaces,
Dashbar: DashbarEditor,
Notifications: Notifications,
};

You can remove any of these sections and you can create your own sections. The name (for example "Dashbar") is displayed in the left nav of the UserPreferences component. The value (for example "DashbarEditor") must be a React component (a "custom panel component"). Clicking on the left nav name causes the React component to display as the active "panel" in the UserPreferences component. There are no specific requirements for the React component other than it display correctly.

You can use the FEAGlobals.FSBL.Clients.ConfigClient API to add preferences to your custom panel component.

You can read more about user preferences in the Configuration tutorial.