Caspeco WebComponents - v3.10.0
    Preparing search index...

    Interface NavigationMenuProps

    interface NavigationMenuProps {
        allowedGroups?: MaybeJson<ItemGroupName[]>;
        basePath?: string;
        bottom: MaybeJson<NavigationItemProps[]>;
        currentLocation: string;
        ignorePermissionCheck?: MaybeJson<boolean>;
        isMobileMenuDisabled?: MaybeJson<boolean>;
        itemGroup: ItemGroupName;
        items: MaybeJson<NavigationItemProps[]>;
        language?: Language;
        showMenuToggle?: MaybeJson<boolean>;
    }
    Index

    Properties

    allowedGroups? basePath? bottom currentLocation ignorePermissionCheck? isMobileMenuDisabled? itemGroup items language? showMenuToggle?

    Properties

    allowedGroups?: MaybeJson<ItemGroupName[]>

    If provided, the menu will only show these groups, if the user has access to them.

    If left undefined, no groups are filtered out. NOTE: empty array means filter out all groups.

    Currently used by Cloud to make sure the user only sees Cloud groups in some cases.

    basePath?: string

    The base path of your application, e.g. /cloud or /checkout. All links will be prefixed with this path. Include a leading slash but no trailing slash.

    bottom: MaybeJson<NavigationItemProps[]>

    The navigation items to display at the bottom of the menu.

    currentLocation: string

    The full URL of the current location (e.g., location.href or SPA equivalent).

    "https://rms.caspeco.se/cloud/home"
    ignorePermissionCheck?: MaybeJson<boolean>

    If provided, the menu will not check for permission. This is useful for groups that are not shown in the menu, but are still used in the application for whatever reason.

    Use with caution, as this will bypass the permission check!

    Will be removed next major version

    isMobileMenuDisabled?: MaybeJson<boolean>

    If false or undefined, the menu will turn into a mobile navigation on viewports below 768px.

    Will be removed in the next major version and mobile menu will always be enabled.

    itemGroup: ItemGroupName

    The identifier of the currently active item group.

    items: MaybeJson<NavigationItemProps[]>

    The navigation items to display within the current item group.

    language?: Language

    The language used for displaying text.

    showMenuToggle?: MaybeJson<boolean>

    Indicates whether the menu toggle button should be displayed. Will always be visible in the next major version.

    Settings

    Member Visibility

    On This Page

    Properties