Contexts Exports Bundle

Table of Contents

Export Package Name: contexts

Export Package Name: `contexts`

How to pull in the module and its components

import { contexts } from '@broadleaf/admin-components';

const { AuthContext } = contexts;

Component Name Description

Component Name	Description
`AuthContext`	The context used for providing the user and authentication state to the Admin application. This context is initialized in `AuthGateway`.
`CatalogContext`	The context used for providing the current global catalog state to the Admin application. This context is initialized & managed in `TrackingContextProvider`. Read more about this context `here`.
`ChangeContainerContext`	The context used for providing the current set of change summaries associated with the sandboxable view to the Admin application. This context is initialized & managed in `ChangeContainerProvider`. Read more about this context `here`.
`ComponentRouterContext`	The context used for providing the current set of metadata component routes to the Admin application. This context is initialized in `ComponentRouter`. Read more about this context `here`.
`DevSettingsContext`	The context used for storing various settings for developer tools, which are only available during development mode. This context is initialized & managed in `DevSettingsProvider`. Read more about this context `here`.
`I18nContext`	The context used for providing the current and available locales for the application. This context is initialized in `I18nProvider`. Read more about this context `here`.
`LocaleContext`	The context used for providing the default locale and allowed locales for the data within the resource services. This context is initialized & managed in `TenantLocaleProvider`. Read more about this context `here`.
`MetadataContext`	The context used for providing the metadata state for the current view. This context is initialized & managed in `ComponentRouteResolver`. Read more about this context `here`.
`SandboxContext`	The context used for providing the sandbox state with the current active sandbox and available sandboxes to the Admin application. This context is initialized & managed in `TrackingContextProvider`. Read more about this context `here`.
`SandboxOperationContext` / `SandboxOperationDispatchContext`	The contexts used for providing the state of executable sandbox operations within sandboxable views. These contexts are initialized & managed in `SandboxOperationProvider`. Read more about these contexts `here`.
`TenantContext`	The context used for providing the current tenant state with tenant and application information to the Admin application. This context is initialized & managed in `TenantGateway`. Read more about this context `here`.
`ToastContainerContext`	The context used for providing the toast state and actions such as adding or removing toasts to the Admin application. This context is initialized & managed in `BaseLayout`. Read more about this context `here`.
`TranslateModeContext` / `TranslateModeDispatchContext`	The context used for providing the state for the `Translate Mode` functionality to the Admin application. This context is initialized & managed in `TranslateModeProvider`. Read more about this context `here`.
`UserAccessContext` / `UserAccessDispatchContext`	The context used for providing user access information & dispatching actions that change the user access state to the Admin application. This context is initialized & managed in `UserAccessProvider`. Read more about this context `here`.

AuthContext

The context used for providing the user and authentication state to the Admin application. This context is initialized in AuthGateway.

CatalogContext

The context used for providing the current global catalog state to the Admin application. This context is initialized & managed in TrackingContextProvider. Read more about this context here.

ChangeContainerContext

The context used for providing the current set of change summaries associated with the sandboxable view to the Admin application. This context is initialized & managed in ChangeContainerProvider. Read more about this context here.

ComponentRouterContext

The context used for providing the current set of metadata component routes to the Admin application. This context is initialized in ComponentRouter. Read more about this context here.

DevSettingsContext

The context used for storing various settings for developer tools, which are only available during development mode. This context is initialized & managed in DevSettingsProvider. Read more about this context here.

I18nContext

The context used for providing the current and available locales for the application. This context is initialized in I18nProvider. Read more about this context here.

LocaleContext

The context used for providing the default locale and allowed locales for the data within the resource services. This context is initialized & managed in TenantLocaleProvider. Read more about this context here.

MetadataContext

The context used for providing the metadata state for the current view. This context is initialized & managed in ComponentRouteResolver. Read more about this context here.

SandboxContext

The context used for providing the sandbox state with the current active sandbox and available sandboxes to the Admin application. This context is initialized & managed in TrackingContextProvider. Read more about this context here.

SandboxOperationContext / SandboxOperationDispatchContext

The contexts used for providing the state of executable sandbox operations within sandboxable views. These contexts are initialized & managed in SandboxOperationProvider. Read more about these contexts here.

TenantContext

The context used for providing the current tenant state with tenant and application information to the Admin application. This context is initialized & managed in TenantGateway. Read more about this context here.

ToastContainerContext

The context used for providing the toast state and actions such as adding or removing toasts to the Admin application. This context is initialized & managed in BaseLayout. Read more about this context here.

TranslateModeContext / TranslateModeDispatchContext

The context used for providing the state for the Translate Mode functionality to the Admin application. This context is initialized & managed in TranslateModeProvider. Read more about this context here.

UserAccessContext / UserAccessDispatchContext

The context used for providing user access information & dispatching actions that change the user access state to the Admin application. This context is initialized & managed in UserAccessProvider. Read more about this context here.

Contexts Exports Bundle

Export Package Name: contexts

Export Package Name: `contexts`