svelte-flex

💪 A simple and reusable flexbox component for Svelte.

A simple and reusable flexbox component for Svelte.

Sane defaults.
Simple API.
Reactive props.
Minimal size.

Try me on CodeSandbox!

Requirements

This package assumes you are using at least Svelte 4.x, and that is the only major version which is actively tested. It may work in some older versions, however

This package requires at least svelte@3.46.2 to work, as it makes use of the style directives feature introduced in the 3.46.x version.

Installation

This package is available on NPM, and you can install it with npm or yarn:

npm install -D svelte-flex

yarn add -D svelte-flex

Usage

Import the Flex component and use it in your Svelte project.

<script>
  import Flex from 'svelte-flex';
</script>

<Flex>
  <div>Flexbox child!</div>
  <div>Flexbox child!</div>
  <div>Flexbox child!</div>
</Flex>

Props

All props are optional (as they all have default values).

Prop	Possible Values	Default Value
`direction`	`'row'` \| `'column'`	`'row'`
`align`	`'start'` \| `'center'` \| `'end'` \| `'stretch'`	`'center'`
`justify`	`'start'` \| `'center'` \| `'end'` \| `'around'` \| `'between'` \| `'evenly'`	`'center'`
`reverse`	`true` \| `false`	`false`

Check out the test suite if you're unsure what CSS styles are applied by these props.

The props are reactive, meaning that if they are dynamically updated, the component will update in response.

Additional Props

Any additional props you provide to Flex will be spread onto the root element. This includes custom CSS classes, which will be applied after the flex classes:

Input

<Flex class="my-custom-class" aria-label="flex-boi">
  <span>Flex child</span>
</Flex>

HTML Output

<div class="flex flex-direction--row flex-align--center flex-justify--center my-custom-class" aria-label="flex-boi">
  <span>Flex child</span>
</div>

"Why does this exist?"

I get plenty of comments asking about why this package exists and what value it adds, especially when you could just add your own flex styles and be done with it. This package helps do this in a reusable way so you don't have to think about it, as well as making it easier for folks who may not be as familiar with working with flexbox. Just a reminder that ✨you don't have to use this package✨ if it doesn't suit your needs.

Contributing

Feel free to file an issue or open a pull request. Ensure that you add tests for any new functionality.

👌 Built by Dave Lunny.

Ottozz/svelte-flex