feat(design): add sidebar mode helpers (#3015)

libs/design/sidebar/src/helper/is-docked-mode.spec.ts

@@ -0,0 +1,21 @@
+import { DaffSidebarModeEnum } from '@daffodil/design/sidebar';
+
+import { daffSidebarIsDockedMode } from './is-docked-mode';
+
+describe('@daffodil/design/sidebar | daffSidebarIsDockedMode', () => {
+  it('should be true for side', () => {
+    expect(daffSidebarIsDockedMode(DaffSidebarModeEnum.Side)).toBeTrue();
+  });
+
+  it('should be true for side fixed', () => {
+    expect(daffSidebarIsDockedMode(DaffSidebarModeEnum.SideFixed)).toBeTrue();
+  });
+
+  it('should be false for under', () => {
+    expect(daffSidebarIsDockedMode(DaffSidebarModeEnum.Under)).toBeFalse();
+  });
+
+  it('should be false for over', () => {
+    expect(daffSidebarIsDockedMode(DaffSidebarModeEnum.Over)).toBeFalse();
+  });
+});

libs/design/sidebar/src/helper/is-docked-mode.ts

@@ -0,0 +1,11 @@
+import { DaffSidebarModeEnum } from './sidebar-mode';
+
+const DOCKED_MODES = [
+  DaffSidebarModeEnum.Side,
+  DaffSidebarModeEnum.SideFixed,
+];
+
+/**
+ * Returns whether the passed mode is a docked mode, i.e. side or side-fixed.
+ */
+export const daffSidebarIsDockedMode = (mode: DaffSidebarModeEnum): boolean => DOCKED_MODES.includes(mode);

libs/design/sidebar/src/helper/is-floating-mode.spec.ts

@@ -0,0 +1,21 @@
+import { DaffSidebarModeEnum } from '@daffodil/design/sidebar';
+
+import { daffSidebarIsFloatingMode } from './is-floating-mode';
+
+describe('@daffodil/design/sidebar | daffSidebarIsFloatingMode', () => {
+  it('should be false for side', () => {
+    expect(daffSidebarIsFloatingMode(DaffSidebarModeEnum.Side)).toBeFalse();
+  });
+
+  it('should be false for side fixed', () => {
+    expect(daffSidebarIsFloatingMode(DaffSidebarModeEnum.SideFixed)).toBeFalse();
+  });
+
+  it('should be true for under', () => {
+    expect(daffSidebarIsFloatingMode(DaffSidebarModeEnum.Under)).toBeTrue();
+  });
+
+  it('should be true for over', () => {
+    expect(daffSidebarIsFloatingMode(DaffSidebarModeEnum.Over)).toBeTrue();
+  });
+});

libs/design/sidebar/src/helper/is-floating-mode.ts

@@ -0,0 +1,11 @@
+import { DaffSidebarModeEnum } from './sidebar-mode';
+
+const FLOATING_MODES = [
+  DaffSidebarModeEnum.Under,
+  DaffSidebarModeEnum.Over,
+];
+
+/**
+ * Returns whether the passed mode is a floating mode, i.e. under or over.
+ */
+export const daffSidebarIsFloatingMode = (mode: DaffSidebarModeEnum): boolean => FLOATING_MODES.includes(mode);

libs/design/sidebar/src/public_api.ts

@@ -14,3 +14,5 @@ export {
   DaffSidebarSide,
   DaffSidebarSideEnum,
 } from './helper/sidebar-side';
+export * from './helper/is-docked-mode';
+export * from './helper/is-floating-mode';