Home > @vsf-enterprise/bigcommerce-theme > UseUiStateInterface
# UseUiStateInterface interface
Data and methods returned from the useUiState() composable
Signature:
export interface UseUiStateInterface
# Properties
| Property | Type | Description |
|---|---|---|
| isCartSidebarOpen | ComputedRef<boolean> | Indicates whether the cart sidebar is open |
| isCategoryGridView | ComputedRef<boolean> | Indicates whether the product list uses the grid layout |
| isFilterSidebarOpen | ComputedRef<boolean> | Indicates whether the filter sidebar is open |
| isLoginModalOpen | ComputedRef<boolean> | Indicates whether the login modal is open |
| isMobileMenuOpen | ComputedRef<boolean> | Indicates whether the mobile menu is open |
| isNewsletterModalOpen | ComputedRef<boolean> | Indicates whether the newsletter modal is open |
| isWishlistSidebarOpen | ComputedRef<boolean> | Indicates whether the wishlist sidebar is open |
# Methods
| Method | Description |
|---|---|
| changeToCategoryGridView() | Changes the layout of the category page to grid |
| changeToCategoryListView() | Changes the layout of the category page to a list |
| toggleCartSidebar() | Toggles the visibility of the cart modal |
| toggleFilterSidebar() | Toggles the visibility of the filter sidebar |
| toggleLoginModal() | Toggles the visibility of the login modal |
| toggleMobileMenu() | Toggles the visibility of the mobile menu |
| toggleNewsletterModal() | Toggles the visibility of the newsletter modal |
| toggleWishlistSidebar() | Toggles the visibility of the wishlist sidebar |