svelte-media-query-store
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

npm version

Svelte Media Query Store

Provides you with a reactive store for checking CSS media queries and breakpoint matcher that keep track of the matching state of the given media queries .

Features

  • CSS Media Queries Matcher - Takes a string query, such as (min-width: 800px) and returns a readable store.
  • Breakpoint Matcher : Takes object with breakpoint as a key and a string query as a value and observes browser changes accordingly and returns the matching breakpoint.

Installation

$ npm i svelte-media-query-store

Usage

Breakpoint Matcher

Takes object with breakpoint as a key and a string query as a value and observes browser changes accordingly and returns the matching breakpoint.

<script lang="ts">
  import { derived } from 'svelte/store';
  import { breakpointMatcher } from './lib/store';

  //for breakpoint matcher
  //tailwind breakpoints
  const breakpoints: Record<string, string> = {
    'sm': '(min-width: 640px)',
    'md': '(min-width: 768px)',
    'lg': '(min-width: 1024px)',
    'xl': '(min-width: 1280px)',
    '2xl': '(min-width: 1536px)'
  };

  const currentBreakpointMatcher = breakpointMatcher(breakpoints);

  // use derived store for conditions so it can be reactive
  const isXl = derived(currentBreakpointMatcher, ($currentBreakpointMatcher) => {
    return $currentBreakpointMatcher === 'xl';
  });
</script>

<h1>Breakpoint Matcher</h1>
<h2>Current Breakpoint: <b>{ $currentBreakpointMatcher }</b></h2>
<h2>IsXL: {$isXl}</h2>

CSS Media Queries Matcher

The package takes a string query, such as (min-width: 800px) and returns a readable store.

In frontend

<script lang="ts">
  import {mediaQueryStore} from 'svelte-media-query-store';

  const isMobile = mediaQueryStore("(max-width: 600px)");
</script>

<h2>{$isMobile}</h2> <!-- subscribing to the readable store --->

In Store

store.ts

## store.ts
import { mediaQueryStore } from 'svelte-media-query-store';

export const md = mediaQueryStore('(min-width: 768px)');

export const lg = mediaQueryStore('(min-width: 1024px)');

App.svelte

<script lang="ts">
  import { md,lg } from '$lib/store'; //
</script>

<h2>md: {$md}</h2>
<h2>lg: {$lg}</h2>

Example

Author

Package Sidebar

Install

npm i svelte-media-query-store

Weekly Downloads

5

Version

1.0.0

License

MIT

Unpacked Size

6.75 kB

Total Files

8

Last publish

Collaborators

  • michaelbelete