@salt-ds/embla-carousel 0.1.5 → 1.0.0

package/dist-es/CarouselAnnouncementPlugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CarouselAnnouncementPlugin.js","sources":["../src/CarouselAnnouncementPlugin.ts"],"sourcesContent":["import { useAriaAnnouncer } from \"@salt-ds/core\";\nimport type {\n  CreateOptionsType,\n  CreatePluginType,\n  EmblaCarouselType,\n} from \"embla-carousel\";\nimport { useCallback } from \"react\";\n\ndeclare module \"embla-carousel\" {\n  interface EmblaPluginsType {\n    announcement: CarouselAnnouncementType;\n  }\n}\n\n/**\n * Type definition for the parameters of the getSlideLabel function.\n * @returns A string that describes the slide, including its index and total count.\n */\nexport type GetSlideLabelProps = (emblaApi: EmblaCarouselType) => string;\n\n/** * Generates a label for a carousel slide based on ARIA attributes.\n * This function retrieves the slide's ARIA label or text content and formats it into a descriptive string.\n * @param slideElement\n * @param slideIndex\n * @param slideCount\n * @returns A string description of the slide, including its position and ARIA label or text content.\n */\nexport const getSlideLabel: GetSlideLabelProps = (emblaApi): string => {\n  const slideCount = emblaApi?.slideNodes().length ?? 0;\n  const slideIndexInView = emblaApi?.slidesInView()?.[0] ?? 0;\n  const slideElement = emblaApi?.slideNodes()[slideIndexInView];\n\n  let description = slideElement?.getAttribute(\"aria-label\");\n  if (!description) {\n    const labelledById = slideElement?.getAttribute(\"aria-labelledby\");\n    const { ownerDocument } = emblaApi.internalEngine();\n    if (labelledById) {\n      const labelledByElement = ownerDocument.getElementById(labelledById);\n      description =\n        labelledByElement?.textContent || \"No description available\";\n    } else {\n      description = \"No description available\";\n    }\n  }\n  return `slide ${slideIndexInView + 1} of ${slideCount}. ${description}`;\n};\n\n// biome-ignore lint/complexity/noBannedTypes: Replicated from embla docs/code\ntype OptionsType = CreateOptionsType<{}>;\n// biome-ignore lint/complexity/noBannedTypes: Replicated from embla docs/code\nexport type CarouselAnnouncementType = CreatePluginType<{}, OptionsType>;\n\nexport type CarouselAnnouncementOptionsType =\n  CarouselAnnouncementType[\"options\"];\n\nexport function CarouselAnnouncement(\n  userOptions: CarouselAnnouncementOptionsType = {},\n): CarouselAnnouncementType {\n  let emblaApi: EmblaCarouselType;\n\n  const { announce } = useAriaAnnouncer();\n\n  const handleSettle = useCallback(\n    (emblaApi: EmblaCarouselType) => {\n      const slideLabel = getSlideLabel(emblaApi);\n      announce(slideLabel);\n    },\n    [announce],\n  );\n\n  function init(emblaApiInstance: EmblaCarouselType): void {\n    emblaApi = emblaApiInstance;\n    emblaApi.on(\"settle\", handleSettle);\n  }\n\n  function destroy(): void {\n    emblaApi.off(\"settle\", handleSettle);\n  }\n\n  const self: CarouselAnnouncementType = {\n    name: \"announcement\",\n    options: userOptions,\n    init,\n    destroy,\n  };\n  return self;\n}\n"],"names":["emblaApi"],"mappings":";;;AA2Ba,MAAA,aAAA,GAAoC,CAAC,QAAqB,KAAA;AA3BvE,EAAA,IAAA,EAAA;AA4BE,EAAM,MAAA,UAAA,GAAA,CAAa,QAAU,IAAA,IAAA,GAAA,MAAA,GAAA,QAAA,CAAA,UAAA,EAAA,CAAa,MAAU,KAAA,CAAA;AACpD,EAAA,MAAM,gBAAmB,GAAA,CAAA,CAAA,EAAA,GAAA,QAAA,IAAA,IAAA,GAAA,MAAA,GAAA,QAAA,CAAU,YAAV,EAAA,KAAA,IAAA,GAAA,MAAA,GAAA,EAAA,CAA2B,CAAM,CAAA,KAAA,CAAA;AAC1D,EAAM,MAAA,YAAA,GAAe,qCAAU,UAAa,EAAA,CAAA,gBAAA,CAAA;AAE5C,EAAI,IAAA,WAAA,GAAc,6CAAc,YAAa,CAAA,YAAA,CAAA;AAC7C,EAAA,IAAI,CAAC,WAAa,EAAA;AAChB,IAAM,MAAA,YAAA,GAAe,6CAAc,YAAa,CAAA,iBAAA,CAAA;AAChD,IAAA,MAAM,EAAE,aAAA,EAAkB,GAAA,QAAA,CAAS,cAAe,EAAA;AAClD,IAAA,IAAI,YAAc,EAAA;AAChB,MAAM,MAAA,iBAAA,GAAoB,aAAc,CAAA,cAAA,CAAe,YAAY,CAAA;AACnE,MAAA,WAAA,GAAA,CACE,uDAAmB,WAAe,KAAA,0BAAA;AAAA,KAC/B,MAAA;AACL,MAAc,WAAA,GAAA,0BAAA;AAAA;AAChB;AAEF,EAAA,OAAO,SAAS,gBAAmB,GAAA,CAAC,CAAO,IAAA,EAAA,UAAU,KAAK,WAAW,CAAA,CAAA;AACvE;AAUgB,SAAA,oBAAA,CACd,WAA+C,GAAA,EACrB,EAAA;AAC1B,EAAI,IAAA,QAAA;AAEJ,EAAM,MAAA,EAAE,QAAS,EAAA,GAAI,gBAAiB,EAAA;AAEtC,EAAA,MAAM,YAAe,GAAA,WAAA;AAAA,IACnB,CAACA,SAAgC,KAAA;AAC/B,MAAM,MAAA,UAAA,GAAa,cAAcA,SAAQ,CAAA;AACzC,MAAA,QAAA,CAAS,UAAU,CAAA;AAAA,KACrB;AAAA,IACA,CAAC,QAAQ;AAAA,GACX;AAEA,EAAA,SAAS,KAAK,gBAA2C,EAAA;AACvD,IAAW,QAAA,GAAA,gBAAA;AACX,IAAS,QAAA,CAAA,EAAA,CAAG,UAAU,YAAY,CAAA;AAAA;AAGpC,EAAA,SAAS,OAAgB,GAAA;AACvB,IAAS,QAAA,CAAA,GAAA,CAAI,UAAU,YAAY,CAAA;AAAA;AAGrC,EAAA,MAAM,IAAiC,GAAA;AAAA,IACrC,IAAM,EAAA,cAAA;AAAA,IACN,OAAS,EAAA,WAAA;AAAA,IACT,IAAA;AAAA,IACA;AAAA,GACF;AACA,EAAO,OAAA,IAAA;AACT;;;;"}

package/dist-es/CarouselProgressLabel.css.js

@@ -1,4 +0,0 @@
-var css_248z = ".saltCarouselTabList.saltText {\n  font-weight: var(--salt-text-fontWeight-strong);\n}\n";
-
-export { css_248z as default };
-//# sourceMappingURL=CarouselProgressLabel.css.js.map

package/dist-es/CarouselProgressLabel.css.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CarouselProgressLabel.css.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist-types/CarouselAnnouncementPlugin.d.ts

@@ -1,24 +0,0 @@
-import type { CreateOptionsType, CreatePluginType, EmblaCarouselType } from "embla-carousel";
-declare module "embla-carousel" {
-    interface EmblaPluginsType {
-        announcement: CarouselAnnouncementType;
-    }
-}
-/**
- * Type definition for the parameters of the getSlideLabel function.
- * @returns A string that describes the slide, including its index and total count.
- */
-export type GetSlideLabelProps = (emblaApi: EmblaCarouselType) => string;
-/** * Generates a label for a carousel slide based on ARIA attributes.
- * This function retrieves the slide's ARIA label or text content and formats it into a descriptive string.
- * @param slideElement
- * @param slideIndex
- * @param slideCount
- * @returns A string description of the slide, including its position and ARIA label or text content.
- */
-export declare const getSlideLabel: GetSlideLabelProps;
-type OptionsType = CreateOptionsType<{}>;
-export type CarouselAnnouncementType = CreatePluginType<{}, OptionsType>;
-export type CarouselAnnouncementOptionsType = CarouselAnnouncementType["options"];
-export declare function CarouselAnnouncement(userOptions?: CarouselAnnouncementOptionsType): CarouselAnnouncementType;
-export {};