diff --git a/src/Breakpoint/Breakpoint.svelte b/src/Breakpoint/Breakpoint.svelte index 8eb93c8c..c040e903 100644 --- a/src/Breakpoint/Breakpoint.svelte +++ b/src/Breakpoint/Breakpoint.svelte @@ -26,7 +26,7 @@ import { createEventDispatcher } from "svelte"; import { breakpointObserver } from "./breakpointObserver"; - import { breakpoints } from "./constants"; + import { breakpoints } from "./breakpoints"; const dispatch = createEventDispatcher(); const observer = breakpointObserver(); diff --git a/src/Breakpoint/breakpointObserver.d.ts b/src/Breakpoint/breakpointObserver.d.ts index 46da45a8..6c8cbdf1 100644 --- a/src/Breakpoint/breakpointObserver.d.ts +++ b/src/Breakpoint/breakpointObserver.d.ts @@ -1,19 +1,22 @@ +import type { Readable, Subscriber, Unsubscriber } from "svelte/store"; +import type { BreakpointSize, BreakpointValue } from "./breakpoints"; + /** - * Creates a readable store that returns the current {@link BreakpointSize}. + * Creates a readable store that returns the current breakpoint size. * It also provides functions for creating derived stores used to do comparisons. */ export function breakpointObserver(): { - subscribe: (this: void, run: import("svelte/store").Subscriber, invalidate?: (value?: any) => void) => import("svelte/store").Unsubscriber; + subscribe: (this: void, run: Subscriber, invalidate?: (value?: any) => void) => Unsubscriber; /** * Returns a store readable store that returns whether the current * breakpoint is smaller than {@link size}. * @param {BreakpointSize} size Size to compare against. */ - smallerThan: (size: BreakpointSize) => import("svelte/store").Readable; + smallerThan: (size: BreakpointSize) => Readable; /** * Returns a store readable store that returns whether the current * breakpoint is larger than {@link size}. * @param {BreakpointSize} size Size to compare against. */ - largerThan: (size: BreakpointSize) => import("svelte/store").Readable; + largerThan: (size: BreakpointSize) => Readable; }; diff --git a/src/Breakpoint/breakpointObserver.js b/src/Breakpoint/breakpointObserver.js index 3f5418cd..a5836bd6 100644 --- a/src/Breakpoint/breakpointObserver.js +++ b/src/Breakpoint/breakpointObserver.js @@ -1,18 +1,16 @@ -/// - import { onMount } from "svelte"; import { derived, writable } from "svelte/store"; -import { breakpoints } from "./constants"; +import { breakpoints } from "./breakpoints"; /** - * Creates a readable store that returns the current {@link BreakpointSize}. + * Creates a readable store that returns the current breakpoint size. * It also provides functions for creating derived stores used to do comparisons. */ export function breakpointObserver() { const store = writable(undefined); onMount(() => { - /** @type {Record} */ + /** @type {Record} */ const match = { sm: window.matchMedia(`(max-width: ${breakpoints.md}px)`), md: window.matchMedia( @@ -57,7 +55,7 @@ export function breakpointObserver() { /** * Returns a store readable store that returns whether the current * breakpoint is smaller than {@link size}. - * @param {BreakpointSize} size Size to compare against. + * @param {import("./breakpoints").BreakpointSize} size Size to compare against. */ smallerThan: (size) => { checkSizeValid(size); @@ -67,7 +65,7 @@ export function breakpointObserver() { /** * Returns a store readable store that returns whether the current * breakpoint is larger than {@link size}. - * @param {BreakpointSize} size Size to compare against. + * @param {import("./breakpoints").BreakpointSize} size Size to compare against. */ largerThan: (size) => { checkSizeValid(size); diff --git a/src/Breakpoint/constants.d.ts b/src/Breakpoint/breakpoints.d.ts similarity index 55% rename from src/Breakpoint/constants.d.ts rename to src/Breakpoint/breakpoints.d.ts index 357b04d5..86da62ef 100644 --- a/src/Breakpoint/constants.d.ts +++ b/src/Breakpoint/breakpoints.d.ts @@ -3,3 +3,7 @@ * @type {Record} */ export const breakpoints: Record; + +export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; + +export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584; diff --git a/src/Breakpoint/constants.js b/src/Breakpoint/breakpoints.js similarity index 63% rename from src/Breakpoint/constants.js rename to src/Breakpoint/breakpoints.js index 31d83113..5773f066 100644 --- a/src/Breakpoint/constants.js +++ b/src/Breakpoint/breakpoints.js @@ -1,8 +1,6 @@ -/// - /** * Pixel sizes of Carbon grid breakpoints. - * @type {Record} + * @type {Record} */ export const breakpoints = Object.freeze({ sm: 320, diff --git a/src/Breakpoint/index.d.ts b/src/Breakpoint/index.d.ts index ec1563a6..e9046700 100644 --- a/src/Breakpoint/index.d.ts +++ b/src/Breakpoint/index.d.ts @@ -1,2 +1,3 @@ +export { default as Breakpoint } from "./Breakpoint.svelte"; export { breakpointObserver } from "./breakpointObserver"; -export { breakpoints } from "./constants"; +export { breakpoints } from "./breakpoints"; diff --git a/src/Breakpoint/index.js b/src/Breakpoint/index.js index 5a25c354..749b78c5 100644 --- a/src/Breakpoint/index.js +++ b/src/Breakpoint/index.js @@ -1,3 +1,3 @@ export { default as Breakpoint } from "./Breakpoint.svelte"; export { breakpointObserver } from "./breakpointObserver"; -export { breakpoints } from "./constants"; +export { breakpoints } from "./breakpoints"; diff --git a/src/Breakpoint/types.d.ts b/src/Breakpoint/types.d.ts deleted file mode 100644 index dc6f50b0..00000000 --- a/src/Breakpoint/types.d.ts +++ /dev/null @@ -1,2 +0,0 @@ -declare type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; -declare type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;