mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-20 20:33:02 +00:00
Rename constants.
Move breakpoint types to same file. Add component export. Inline type imports in JS files.
This commit is contained in:
parent
213d4debe7
commit
ec35905e6c
8 changed files with 21 additions and 19 deletions
|
@ -26,7 +26,7 @@
|
||||||
|
|
||||||
import { createEventDispatcher } from "svelte";
|
import { createEventDispatcher } from "svelte";
|
||||||
import { breakpointObserver } from "./breakpointObserver";
|
import { breakpointObserver } from "./breakpointObserver";
|
||||||
import { breakpoints } from "./constants";
|
import { breakpoints } from "./breakpoints";
|
||||||
|
|
||||||
const dispatch = createEventDispatcher();
|
const dispatch = createEventDispatcher();
|
||||||
const observer = breakpointObserver();
|
const observer = breakpointObserver();
|
||||||
|
|
11
src/Breakpoint/breakpointObserver.d.ts
vendored
11
src/Breakpoint/breakpointObserver.d.ts
vendored
|
@ -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.
|
* It also provides functions for creating derived stores used to do comparisons.
|
||||||
*/
|
*/
|
||||||
export function breakpointObserver(): {
|
export function breakpointObserver(): {
|
||||||
subscribe: (this: void, run: import("svelte/store").Subscriber<any>, invalidate?: (value?: any) => void) => import("svelte/store").Unsubscriber;
|
subscribe: (this: void, run: Subscriber<any>, invalidate?: (value?: any) => void) => Unsubscriber;
|
||||||
/**
|
/**
|
||||||
* Returns a store readable store that returns whether the current
|
* Returns a store readable store that returns whether the current
|
||||||
* breakpoint is smaller than {@link size}.
|
* breakpoint is smaller than {@link size}.
|
||||||
* @param {BreakpointSize} size Size to compare against.
|
* @param {BreakpointSize} size Size to compare against.
|
||||||
*/
|
*/
|
||||||
smallerThan: (size: BreakpointSize) => import("svelte/store").Readable<boolean>;
|
smallerThan: (size: BreakpointSize) => Readable<boolean>;
|
||||||
/**
|
/**
|
||||||
* Returns a store readable store that returns whether the current
|
* Returns a store readable store that returns whether the current
|
||||||
* breakpoint is larger than {@link size}.
|
* breakpoint is larger than {@link size}.
|
||||||
* @param {BreakpointSize} size Size to compare against.
|
* @param {BreakpointSize} size Size to compare against.
|
||||||
*/
|
*/
|
||||||
largerThan: (size: BreakpointSize) => import("svelte/store").Readable<boolean>;
|
largerThan: (size: BreakpointSize) => Readable<boolean>;
|
||||||
};
|
};
|
||||||
|
|
|
@ -1,18 +1,16 @@
|
||||||
/// <reference path="./types.d.ts"/>
|
|
||||||
|
|
||||||
import { onMount } from "svelte";
|
import { onMount } from "svelte";
|
||||||
import { derived, writable } from "svelte/store";
|
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.
|
* It also provides functions for creating derived stores used to do comparisons.
|
||||||
*/
|
*/
|
||||||
export function breakpointObserver() {
|
export function breakpointObserver() {
|
||||||
const store = writable(undefined);
|
const store = writable(undefined);
|
||||||
|
|
||||||
onMount(() => {
|
onMount(() => {
|
||||||
/** @type {Record<BreakpointSize, MediaQueryList>} */
|
/** @type {Record<import("./breakpoints").BreakpointSize, MediaQueryList>} */
|
||||||
const match = {
|
const match = {
|
||||||
sm: window.matchMedia(`(max-width: ${breakpoints.md}px)`),
|
sm: window.matchMedia(`(max-width: ${breakpoints.md}px)`),
|
||||||
md: window.matchMedia(
|
md: window.matchMedia(
|
||||||
|
@ -57,7 +55,7 @@ export function breakpointObserver() {
|
||||||
/**
|
/**
|
||||||
* Returns a store readable store that returns whether the current
|
* Returns a store readable store that returns whether the current
|
||||||
* breakpoint is smaller than {@link size}.
|
* breakpoint is smaller than {@link size}.
|
||||||
* @param {BreakpointSize} size Size to compare against.
|
* @param {import("./breakpoints").BreakpointSize} size Size to compare against.
|
||||||
*/
|
*/
|
||||||
smallerThan: (size) => {
|
smallerThan: (size) => {
|
||||||
checkSizeValid(size);
|
checkSizeValid(size);
|
||||||
|
@ -67,7 +65,7 @@ export function breakpointObserver() {
|
||||||
/**
|
/**
|
||||||
* Returns a store readable store that returns whether the current
|
* Returns a store readable store that returns whether the current
|
||||||
* breakpoint is larger than {@link size}.
|
* breakpoint is larger than {@link size}.
|
||||||
* @param {BreakpointSize} size Size to compare against.
|
* @param {import("./breakpoints").BreakpointSize} size Size to compare against.
|
||||||
*/
|
*/
|
||||||
largerThan: (size) => {
|
largerThan: (size) => {
|
||||||
checkSizeValid(size);
|
checkSizeValid(size);
|
||||||
|
|
|
@ -3,3 +3,7 @@
|
||||||
* @type {Record<BreakpointSize, BreakpointValue>}
|
* @type {Record<BreakpointSize, BreakpointValue>}
|
||||||
*/
|
*/
|
||||||
export const breakpoints: Record<BreakpointSize, BreakpointValue>;
|
export const breakpoints: Record<BreakpointSize, BreakpointValue>;
|
||||||
|
|
||||||
|
export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max";
|
||||||
|
|
||||||
|
export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;
|
|
@ -1,8 +1,6 @@
|
||||||
/// <reference path="./types.d.ts"/>
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Pixel sizes of Carbon grid breakpoints.
|
* Pixel sizes of Carbon grid breakpoints.
|
||||||
* @type {Record<BreakpointSize, BreakpointValue>}
|
* @type {Record<import("./breakpoints").BreakpointSize, BreakpointValue>}
|
||||||
*/
|
*/
|
||||||
export const breakpoints = Object.freeze({
|
export const breakpoints = Object.freeze({
|
||||||
sm: 320,
|
sm: 320,
|
3
src/Breakpoint/index.d.ts
vendored
3
src/Breakpoint/index.d.ts
vendored
|
@ -1,2 +1,3 @@
|
||||||
|
export { default as Breakpoint } from "./Breakpoint.svelte";
|
||||||
export { breakpointObserver } from "./breakpointObserver";
|
export { breakpointObserver } from "./breakpointObserver";
|
||||||
export { breakpoints } from "./constants";
|
export { breakpoints } from "./breakpoints";
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
export { default as Breakpoint } from "./Breakpoint.svelte";
|
export { default as Breakpoint } from "./Breakpoint.svelte";
|
||||||
export { breakpointObserver } from "./breakpointObserver";
|
export { breakpointObserver } from "./breakpointObserver";
|
||||||
export { breakpoints } from "./constants";
|
export { breakpoints } from "./breakpoints";
|
||||||
|
|
2
src/Breakpoint/types.d.ts
vendored
2
src/Breakpoint/types.d.ts
vendored
|
@ -1,2 +0,0 @@
|
||||||
declare type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max";
|
|
||||||
declare type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;
|
|
Loading…
Add table
Add a link
Reference in a new issue