Home > @shopware-pwa/composables > useUIState

useUIState variable

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Simple state management for UI purposes. If you pase stateName on composable invocation (ex. useUIState('sidebarCart')), then state is shared between all instances with this key. Otherwise state is local, so multiple useUIState() will not share state

Signature:

useUIState: (stateName?: string | undefined) => {
    isOpen: Readonly<Ref<boolean>>;
    switchState: (to?: boolean | undefined) => void;
}