diff --git a/docs/src/pages/framed/Breakpoint/BreakpointObserver.svelte b/docs/src/pages/framed/Breakpoint/BreakpointObserver.svelte index a37e4683..db427d3a 100644 --- a/docs/src/pages/framed/Breakpoint/BreakpointObserver.svelte +++ b/docs/src/pages/framed/Breakpoint/BreakpointObserver.svelte @@ -1,8 +1,5 @@ +{smaller} +{larger} +{breakpoints.md} + , + 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) => 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) => Readable; +}; + +export default breakpointObserver; diff --git a/types/Breakpoint/breakpoints.d.ts b/types/Breakpoint/breakpoints.d.ts new file mode 100644 index 00000000..0f89df39 --- /dev/null +++ b/types/Breakpoint/breakpoints.d.ts @@ -0,0 +1,11 @@ +/** + * Pixel sizes of Carbon grid breakpoints. + * @type {Record} + */ +export const breakpoints: Record; + +export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; + +export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584; + +export default breakpoints; diff --git a/types/Breakpoint/index.d.ts b/types/Breakpoint/index.d.ts new file mode 100644 index 00000000..e9046700 --- /dev/null +++ b/types/Breakpoint/index.d.ts @@ -0,0 +1,3 @@ +export { default as Breakpoint } from "./Breakpoint.svelte"; +export { breakpointObserver } from "./breakpointObserver"; +export { breakpoints } from "./breakpoints"; diff --git a/types/index.d.ts b/types/index.d.ts index 105d9c70..40399657 100644 --- a/types/index.d.ts +++ b/types/index.d.ts @@ -6,8 +6,8 @@ export { default as Breadcrumb } from "./Breadcrumb/Breadcrumb.svelte"; export { default as BreadcrumbItem } from "./Breadcrumb/BreadcrumbItem.svelte"; export { default as BreadcrumbSkeleton } from "./Breadcrumb/BreadcrumbSkeleton.svelte"; export { default as Breakpoint } from "./Breakpoint/Breakpoint.svelte"; -export { default as breakpointObserver } from "./Breakpoint"; -export { default as breakpoints } from "./Breakpoint"; +export { default as breakpointObserver } from "./Breakpoint/breakpointObserver"; +export { default as breakpoints } from "./Breakpoint/breakpoints"; export { default as Button } from "./Button/Button.svelte"; export { default as ButtonSkeleton } from "./Button/ButtonSkeleton.svelte"; export { default as ButtonSet } from "./Button/ButtonSet.svelte";