0.2.0 • Published 5 years ago

svelte-fluid-layout v0.2.0

Weekly downloads
5
License
MIT
Repository
github
Last release
5 years ago

svelte-fluid-layout

A Svelte component to create a responsive layout for your app.

Demo

Example | Code Sandbox

Install

npm i svelte-fluid-layout

Usage

There are five slots (header, main, footer, side1, and side2). When using them all, you achieve a (responsive) holy grail layout.

<script>
  import Layout from "svelte-fluid-layout";
</script>

<Layout>
  <header slot="header">My Header</header>
  <section slot="side1">My Section</section>
  <main slot="main">My Main</main>
  <aside slot="side2">My Aside</aside>
  <footer slot="footer">Footer</footer>
</Layout>

<style>
  :global(.svelte-fluid-layout-large main) {
    width: 66%;
  }
</style>

You can use .svelte-fluid-layout-large .my-element and .svelte-fluid-layout-small .my-element to target your slotted elements at either display size, small or large (horizontal or vertical).

Give a width to the main slot on large screens (see style section above), as by default it only takes up the size of its inner content (which will be collapsed at first with no content). side1 and side2 share whatever is left over.

The side1 and side2 slots are not required, hence you don't have to use the holy grail layout.

Props

breakpoint

The breakpoint at which the layout switches from horizontal to vertical. Valid values are:

  • sm (640px)
  • md(768px),
  • lg(1024px),
  • xl(1200px).

    The default value is sm;

    <Layout breakpoint='md'>
      <!-- slots -->
    </Layout>