@flightlesslabs/dodo-ui 0.10.3 → 0.11.1

package/src/lib/stories/components/Info/Calendar/utils/createDateOfMonth/index.mdx

@@ -0,0 +1,121 @@
+import { Source } from '@storybook/addon-docs/blocks';
+
+# `createDateOfMonth`
+
+`createDateOfMonth(date, settings, monthType?, manipulateDate?)` creates a single `DateOfMonth` object representing one calendar cell. This is typically used internally by `getDatesOfMonth` but can be useful for custom logic.
+
+## Usage
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Manual usage for one day
+import { createDateOfMonth } from '@flightlesslabs/dodo-ui';
+
+const date = new Date();
+const dateObj = createDateOfMonth(date, {
+minDate: new Date('2025-01-01'),
+timezone: 'UTC',
+}, 'currentMonth');
+`}
+/>
+
+---
+
+# Types
+
+## `DateOfMonth`
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Represents a single calendar cell
+type DateOfMonth = {
+  id: string;
+  date: Date;
+  isCurrentMonth: boolean;
+  isLastMonth?: boolean;
+  isNextMonth?: boolean;
+  disabled?: boolean;
+  today?: boolean;
+};
+`}
+/>
+
+## `CreateDatesOfMonthSettings`
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Configuration for calendar generation
+interface CreateDatesOfMonthSettings {
+  startOfWeek?: 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT';
+  showLastMonth?: boolean;
+  showNextMonth?: boolean;
+  today?: Date;
+  minDate?: Date;
+  maxDate?: Date;
+  excludeDates?: Date[];
+  includeDates?: Date[];
+  timezone?: string;
+  utc?: boolean;
+}
+`}
+/>
+
+## `CreateDateOfMonthType`
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Indicates the month context of the date
+type CreateDateOfMonthType = 'currentMonth' | 'nextMonth' | 'lastMonth';
+`}
+/>
+
+## `DAYS_OF_WEEK` Enum
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Weekday constants (Sunday = 0)
+export const enum DAYS_OF_WEEK {
+  SUN,
+  MON,
+  TUE,
+  WED,
+  THU,
+  FRI,
+  SAT,
+}
+`}
+/>
+
+## `MONTHS` Enum
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Month constants (January = 0)
+export const enum MONTHS {
+  JAN,
+  FEB,
+  MAR,
+  APR,
+  MAY,
+  JUN,
+  JUL,
+  AUG,
+  SEP,
+  OCT,
+  NOV,
+  DEC,
+}
+`}
+/>

package/src/lib/stories/components/Info/Calendar/utils/{getDatesOfMonth.ts → getDatesOfMonth/getDatesOfMonth.ts}

@@ -1,16 +1,18 @@
 import getMoment from '$lib/stories/developer tools/helpers/Time/getMoment/getMoment.js';
-
-import type { DateOfMonth } from './types.js';
-import { calendarWeekOptions } from '$lib/index.js';
-import createDateOfMonth, { type CreateDatesOfMonthSettings } from './createDateOfMonth.js';
+import {
+  calendarWeekOptions,
+  createDateOfMonth,
+  type CreateDatesOfMonthSettings,
+  type DateOfMonth,
+} from '$lib/index.js';
 
 /**
  * Divides an array into chunks of a given size.
  *
  * @template T - The type of elements in the array.
- * @param {T[]} arr - The array to be chunked.
- * @param {number} size - The chunk size.
- * @returns {T[][]} - An array of chunks.
+ * @param arr - The array to be chunked.
+ * @param size - The chunk size.
+ * @returns An array of chunks.
  */
 function chunkArray<T>(arr: T[], size: number): T[][] {
   const result: T[][] = [];
@@ -20,6 +22,13 @@ function chunkArray<T>(arr: T[], size: number): T[][] {
   return result;
 }
 
+/**
+ * Creates a moment object from a Date with optional timezone and UTC settings.
+ *
+ * @param date - The date to convert.
+ * @param settings - Optional settings for timezone and UTC.
+ * @returns A moment object with the applied settings.
+ */
 function dateMoment(date?: Date, settings?: CreateDatesOfMonthSettings) {
   return getMoment(date, undefined, {
     timezone: settings?.timezone,
@@ -30,13 +39,18 @@ function dateMoment(date?: Date, settings?: CreateDatesOfMonthSettings) {
 /**
  * Generates a calendar grid of dates for a given month.
  *
- * @param {Date} date - The base date for the month to generate.
- * @param {GetDatesOfMonthSettings} [settings] - Optional settings for formatting and display.
- * @returns {(DateOfMonth[][] | null)} - A 2D array of DateOfMonth objects representing the calendar, or null if invalid.
+ * @param date - The base date for the month to generate.
+ * @param settings - Optional settings for formatting and display.
+ * @param manipulateDate - Optional function to modify each generated DateOfMonth.
+ * @returns A 2D array of DateOfMonth objects representing the calendar, or null if invalid.
  */
 export default function getDatesOfMonth(
   date?: Date,
   settings?: CreateDatesOfMonthSettings,
+  manipulateDate?: (
+    dateToModify: DateOfMonth,
+    settings?: CreateDatesOfMonthSettings,
+  ) => DateOfMonth,
 ): DateOfMonth[][] | null {
   if (!date) {
     return null;
@@ -54,6 +68,7 @@ export default function getDatesOfMonth(
   const startOfWeek =
     calendarWeekOptions.find((item) => item.abr3 === settings?.startOfWeek) ||
     calendarWeekOptions[0];
+
   const rawStartOfMonthDay = monthMoment.day();
   const startOfMonthDay = (rawStartOfMonthDay - startOfWeek.value + 7) % 7;
 
@@ -66,15 +81,13 @@ export default function getDatesOfMonth(
   if (showLastMonth) {
     for (let gap = 0; gap < startOfMonthDay; gap++) {
       const dayMoment = lastMonth.clone().add(gap, 'days');
-
-      dates.push(createDateOfMonth(dayMoment.toDate(), settings, 'lastMonth'));
+      dates.push(createDateOfMonth(dayMoment.toDate(), settings, 'lastMonth', manipulateDate));
     }
   }
 
   for (let day = 1; day <= daysInMonth; day++) {
     const dayMoment = monthMoment.clone().set('date', day);
-
-    dates.push(createDateOfMonth(dayMoment.toDate(), settings, 'currentMonth'));
+    dates.push(createDateOfMonth(dayMoment.toDate(), settings, 'currentMonth', manipulateDate));
   }
 
   const datesDivided = chunkArray<DateOfMonth>(dates, 7);
@@ -88,8 +101,9 @@ export default function getDatesOfMonth(
 
       for (let gap = 0; gap < nextMonthDaysRequired; gap++) {
         const dayMoment = nextMonth.clone().add(gap, 'days');
-
-        nextMonthDates.push(createDateOfMonth(dayMoment.toDate(), settings, 'nextMonth'));
+        nextMonthDates.push(
+          createDateOfMonth(dayMoment.toDate(), settings, 'nextMonth', manipulateDate),
+        );
       }
 
       datesDivided[datesDivided.length - 1] = [...lastRow, ...nextMonthDates];

package/src/lib/stories/components/Info/Calendar/utils/getDatesOfMonth/index.mdx

@@ -0,0 +1,37 @@
+import { Source } from '@storybook/addon-docs/blocks';
+
+# `getDatesOfMonth`
+
+`getDatesOfMonth(date, settings, manipulateDate)` generates a 2D array of weeks, each containing `DateOfMonth` objects. It supports options via `CreateDatesOfMonthSettings` and allows injecting custom logic per date.
+
+## Usage
+
+<Source
+  dark
+  language="ts"
+  code={`
+// Basic usage
+import { getDatesOfMonth, getMoment } from '@flightlesslabs/dodo-ui';
+
+const dates = getDatesOfMonth(new Date(), {
+showLastMonth: false,
+showNextMonth: false,
+});
+
+// Using a formatted date
+const dates2 = getDatesOfMonth(
+getMoment('01-02-2025', 'DD-MM-YYYY').toDate()
+);
+
+// With custom manipulation
+const dates3 = getDatesOfMonth(new Date(), {
+timezone: 'America/New_York',
+startOfWeek: 'MON',
+}, (date, settings) => {
+return {
+...date,
+disabled: true,
+};
+});
+`}
+/>

package/src/lib/stories/components/Info/Calendar/utils/types.ts

@@ -31,9 +31,4 @@ export type DateOfMonth = {
   isNextMonth?: boolean;
   disabled?: boolean;
   today?: boolean;
-  isRangeStart?: boolean;
-  isRangeEnd?: boolean;
-  inRange?: boolean;
 };
-
-export type DateRangeType = 'start' | 'end';

package/src/lib/stories/components/Layout/Menu/DynamicMenu/Customize/Customize.stories.svelte

@@ -0,0 +1,30 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import DynamicMenu from '../DynamicMenu.svelte';
+  import { dynamicMenuItemOptions, storyDynamicMenuArgTypes } from '../DynamicMenu.stories.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: DynamicMenu,
+    tags: ['autodocs'],
+    argTypes: storyDynamicMenuArgTypes,
+  });
+</script>
+
+<!-- Custom Menu Item Content -->
+<Story name="CustomMenuItemContent" asChild>
+  <DynamicMenu options={dynamicMenuItemOptions}>
+    {#snippet customMenuItemContent(option, selectedOption)}
+      {selectedOption?.id === option.id ? '✅' : ''} {option.label} 💯💯💯
+    {/snippet}
+  </DynamicMenu>
+</Story>
+
+<!-- Custom Menu Item Placeholder Content -->
+<Story name="CustomPlaceholderMenuItemContent" asChild>
+  <DynamicMenu options={[]} showOptionsPlaceholder>
+    {#snippet customPlaceholderMenuItemContent()}
+      No dice 💯💯💯
+    {/snippet}
+  </DynamicMenu>
+</Story>

package/src/lib/stories/components/Layout/Menu/DynamicMenu/DynamicMenu.stories.svelte

@@ -0,0 +1,56 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import DynamicMenu, { type DynamicMenuItemOption } from './DynamicMenu.svelte';
+  import type { StoryBookArgTypes } from '$lib/storybook-types.js';
+
+  export const storyDynamicMenuArgTypes: StoryBookArgTypes = {};
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: DynamicMenu,
+    tags: ['autodocs'],
+    argTypes: storyDynamicMenuArgTypes,
+  });
+
+  export const dynamicMenuItemOptions: DynamicMenuItemOption[] = [
+    {
+      id: '1',
+      label: 'One',
+    },
+    {
+      id: '2',
+      label: 'Two',
+    },
+    {
+      id: '3',
+      label: 'Three',
+    },
+    {
+      id: '4',
+      label: 'Four',
+    },
+    {
+      id: '5',
+      label: 'Five',
+    },
+    {
+      id: '6',
+      disabled: true,
+      label: 'Five',
+    },
+  ];
+</script>
+
+<!-- Default DynamicMenu -->
+<Story name="Default" args={{ options: dynamicMenuItemOptions }} />
+
+<!-- Selected Option -->
+<Story
+  name="SelectedOption"
+  args={{ options: dynamicMenuItemOptions, selectedOption: dynamicMenuItemOptions[1] }}
+/>
+
+<Story
+  name="ShowPlaceholder"
+  args={{ options: [], showOptionsPlaceholder: true, optionsPlaceholder: 'No content found.' }}
+/>

package/src/lib/stories/components/Layout/Menu/DynamicMenu/Events/Events.stories.svelte

@@ -0,0 +1,48 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import { dynamicMenuItemOptions, storyDynamicMenuArgTypes } from '../DynamicMenu.stories.svelte';
+  import DynamicMenu, { type DynamicMenuItemOption } from '../DynamicMenu.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: DynamicMenu,
+    tags: ['autodocs'],
+    argTypes: storyDynamicMenuArgTypes,
+  });
+</script>
+
+<!-- Menu Item onclick -->
+<Story name="onclick" asChild>
+  <DynamicMenu
+    keyboardNavigation
+    options={dynamicMenuItemOptions}
+    onclick={(e: MouseEvent, option: DynamicMenuItemOption) => {
+      e.preventDefault();
+      console.log(option);
+    }}
+  />
+</Story>
+
+<!-- KeyboardNavigation Event: onEnter  -->
+<Story name="onEnter" asChild>
+  <DynamicMenu
+    keyboardNavigation
+    options={dynamicMenuItemOptions}
+    onEnter={(e: KeyboardEvent, menuItemIndex: number) => {
+      e.preventDefault();
+      console.log(menuItemIndex);
+    }}
+  />
+</Story>
+
+<!-- KeyboardNavigation Event: onEsc  -->
+<Story name="onEsc" asChild>
+  <DynamicMenu
+    keyboardNavigation
+    options={dynamicMenuItemOptions}
+    onEsc={(e: KeyboardEvent, menuItemIndex: number) => {
+      e.preventDefault();
+      console.log(menuItemIndex);
+    }}
+  />
+</Story>

package/src/lib/stories/components/Layout/Menu/DynamicMenu/KeybaordNavigation/KeybaordNavigation.stories.svelte

@@ -0,0 +1,29 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import DynamicMenu from '../DynamicMenu.svelte';
+  import { dynamicMenuItemOptions, storyDynamicMenuArgTypes } from '../DynamicMenu.stories.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: DynamicMenu,
+    tags: ['autodocs'],
+    argTypes: storyDynamicMenuArgTypes,
+  });
+</script>
+
+<!-- KeyboardNavigationOn -->
+<Story
+  name="KeyboardNavigationOn"
+  args={{
+    options: dynamicMenuItemOptions,
+    keyboardNavigation: true,
+    onEnter: (e: KeyboardEvent, menuItemIndex: number) => {
+      e.preventDefault();
+      console.log(menuItemIndex);
+    },
+    onEsc: (e: KeyboardEvent, menuItemIndex: number) => {
+      e.preventDefault();
+      console.log(menuItemIndex);
+    },
+  }}
+/>

package/src/lib/stories/components/Layout/Menu/DynamicMenu/Options/OptionFormat.mdx

@@ -0,0 +1,72 @@
+import { Source } from '@storybook/addon-docs/blocks';
+
+# Option Format
+
+## DynamicMenuItemOption
+
+<Source
+  dark
+  language="ts"
+  code={`
+type DynamicMenuItemOption<TMeta = unknown> = {
+    id: string;
+    /** label  */
+    label?: string;
+    /** Custom Metadata  */
+    meta?: TMeta;
+    /** Menu Item type */
+    type?: MenuItemType;
+    /** Menu Separator */
+    separator?: boolean;
+    /** How large should the Menu Items be? */
+    size?: ComponentSize;
+    /** The onclick event handler */
+    onclick?: MouseEventHandler<HTMLButtonElement>;
+    /**  disabled state */
+    disabled?: boolean;
+    /** link href */
+    href?: string;
+    /** Link button: download  */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    download?: any;
+    /** Link button: hreflang  */
+    hreflang?: string | undefined | null;
+    /** Link button: media  */
+    media?: string | undefined | null;
+    /** Link button: ping  */
+    ping?: string | undefined | null;
+    /** Link button: rel  */
+    rel?: string | undefined | null;
+    /** Link button: target  */
+    target?: ButtonLinkTarget;
+    /** Link button: Type  */
+    anchorMediaType?: string | undefined | null;
+    /** Link button: referrerpolicy  */
+    referrerpolicy?: ButtonLinkReferrerpolicy;
+  };
+`}
+/>
+
+## Example values
+
+<Source
+  dark
+  language="ts"
+  code={`
+const options: DynamicMenuItemOption[] = [
+   {
+    id: '1',
+    label: 'One',
+  },
+  {
+    id: '2',
+    label: 'Two',
+  },
+  {
+    id: '3',
+    label: 'Three',
+    disabled: true,
+  },
+];
+`}
+/>

package/src/lib/stories/components/Layout/Menu/Menu.stories.svelte

@@ -0,0 +1,69 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import Menu from './Menu.svelte';
+  import type { StoryBookArgTypes } from '$lib/storybook-types.js';
+  import MenuItem from './MenuItem/MenuItem.svelte';
+  import { Separator } from '$lib/index.js';
+
+  export const storyMenuArgTypes: StoryBookArgTypes = {};
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: Menu,
+    tags: ['autodocs'],
+    argTypes: storyMenuArgTypes,
+  });
+</script>
+
+<!-- Default Menu -->
+<Story name="Default" asChild>
+  <Menu>
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>
+
+<!-- Fixed width and height -->
+<Story name="FixedSize" asChild>
+  <Menu width="200px" height="300px">
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>
+
+<!-- MenuItems With Separator -->
+<Story name="WithSeparator" asChild>
+  <Menu separator>
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>
+
+<!-- MenuItems Grouped in Sections. [Separator](?path=/docs/components-layout-separator--docs) -->
+<Story name="Sections" asChild>
+  <Menu width="200px">
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Cut Special</MenuItem>
+    <MenuItem>Cut Selected</MenuItem>
+    <Separator />
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Copy Special</MenuItem>
+    <MenuItem>Copy Selected</MenuItem>
+    <Separator />
+    <MenuItem>Paste</MenuItem>
+    <MenuItem>Paste Special</MenuItem>
+    <MenuItem>Paste Selected</MenuItem>
+  </Menu>
+</Story>
+
+<!-- MenuItems With some options disabled -->
+<Story name="Disabled" asChild>
+  <Menu>
+    <MenuItem>Cut</MenuItem>
+    <MenuItem disabled>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>

package/src/lib/stories/components/Layout/Menu/MenuItem/MenuItem.stories.svelte

@@ -0,0 +1,34 @@
+<script module lang="ts">
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import type { StoryBookArgTypes } from '$lib/storybook-types.js';
+  import MenuItem, { menuItemTypeArray } from './MenuItem.svelte';
+  import { componentSizeArray } from '$lib/types/size.js';
+
+  export const storyMenuItemArgTypes: StoryBookArgTypes = {
+    type: {
+      control: { type: 'select' },
+      options: menuItemTypeArray,
+    },
+    size: {
+      control: { type: 'select' },
+      options: componentSizeArray,
+    },
+  };
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: MenuItem,
+    tags: ['autodocs'],
+    argTypes: storyMenuItemArgTypes,
+  });
+</script>
+
+<!-- Default MenuItem -->
+<Story name="Default">Menu Item</Story>
+
+<!-- With Separator -->
+<Story name="WithSeparator" args={{ separator: true }}>Menu Item</Story>
+
+<Story name="Disabled" args={{ disabled: true }}>Menu Item</Story>
+
+<Story name="Selected" args={{ selected: true }}>Menu Item</Story>

package/src/lib/stories/components/Layout/Menu/MenuItem/Size/Size.stories.svelte

@@ -0,0 +1,16 @@
+<script module>
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import MenuItem from '../MenuItem.svelte';
+  import { storyMenuItemArgTypes } from '../MenuItem.stories.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: MenuItem,
+    tags: ['autodocs'],
+    argTypes: storyMenuItemArgTypes,
+  });
+</script>
+
+<Story name="Normal">Menu Item</Story>
+<Story name="Small" args={{ size: 'small' }}>Menu Item</Story>
+<Story name="Large" args={{ size: 'large' }}>Menu Item</Story>

package/src/lib/stories/components/Layout/Menu/MenuItem/Type/Type.stories.svelte

@@ -0,0 +1,21 @@
+<script module>
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import MenuItem from '../MenuItem.svelte';
+  import { storyMenuItemArgTypes } from '../MenuItem.stories.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: MenuItem,
+    tags: ['autodocs'],
+    argTypes: storyMenuItemArgTypes,
+  });
+</script>
+
+<Story name="Text">Menu Item</Story>
+<Story
+  name="Link"
+  args={{ type: 'link', href: 'https://www.w3schools.com/tags/tag_a.asp', target: '_blank' }}
+>
+  Menu Item
+</Story>
+<Story name="Button" args={{ type: 'button', onclick: () => {} }}>Menu Item</Story>

package/src/lib/stories/components/Layout/Menu/Size/Size.stories.svelte

@@ -0,0 +1,37 @@
+<script module>
+  import { defineMeta } from '@storybook/addon-svelte-csf';
+  import Menu from '../Menu.svelte';
+  import { storyMenuArgTypes } from '../Menu.stories.svelte';
+  import MenuItem from '../MenuItem/MenuItem.svelte';
+
+  // More on how to set up stories at: https://storybook.js.org/docs/writing-stories
+  const { Story } = defineMeta({
+    component: Menu,
+    tags: ['autodocs'],
+    argTypes: storyMenuArgTypes,
+  });
+</script>
+
+<Story name="Normal" asChild>
+  <Menu>
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>
+
+<Story name="Small" asChild>
+  <Menu size="small">
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>
+
+<Story name="Large" asChild>
+  <Menu size="large">
+    <MenuItem>Cut</MenuItem>
+    <MenuItem>Copy</MenuItem>
+    <MenuItem>Paste</MenuItem>
+  </Menu>
+</Story>