Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fedorovvvv/svelte-floating-ui

Svelte✨ Floating UI 🎈
https://github.com/fedorovvvv/svelte-floating-ui

floating floating-ui svelte sveltejs ui

Last synced: about 2 months ago
JSON representation

Svelte✨ Floating UI 🎈

Host: GitHub
URL: https://github.com/fedorovvvv/svelte-floating-ui
Owner: fedorovvvv
License: mit
Created: 2022-07-03T21:44:00.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-07-15T08:24:06.000Z (2 months ago)
Last Synced: 2024-07-15T10:06:06.099Z (2 months ago)
Topics: floating, floating-ui, svelte, sveltejs, ui
Language: TypeScript
Homepage:
Size: 278 KB
Stars: 144
Watchers: 2
Forks: 7
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  



# 🎈Svelte Floating UI

[![npm version](http://img.shields.io/npm/v/svelte-floating-ui.svg)](https://www.npmjs.com/package/svelte-floating-ui)

[![npm downloads](https://img.shields.io/npm/dm/svelte-floating-ui.svg)](https://www.npmjs.com/package/svelte-floating-ui)

![license](https://img.shields.io/npm/l/svelte-floating-ui)

[Floating UI](https://github.com/floating-ui/floating-ui/) for Svelte with [actions](https://svelte.dev/docs#use_action). No wrapper components or component bindings required!

```bash

npm i svelte-floating-ui @floating-ui/core

```

## Usage

`createFloatingActions` takes an optional [options object](https://floating-ui.com/docs/computePosition#options) for configuring the content placement. The content action also takes an optional [options object](https://floating-ui.com/docs/computePosition#options) for updating the options of the content placement.

`createFloatingActions` also returns an `update` method as it's third value which can be used to [manually update](https://floating-ui.com/docs/computePosition#updating) the content position.

### Example

```svelte

  import { offset, flip, shift } from "svelte-floating-ui/dom";

  import { createFloatingActions } from "svelte-floating-ui";

  const [ floatingRef, floatingContent ] = createFloatingActions({

    strategy: "absolute",

    placement: "top",

    middleware: [

      offset(6),

      flip(),

      shift(),

    ]

  });

  let showTooltip: boolean = false;

 showTooltip = true}

  on:mouseleave={() => showTooltip = false}

  use:floatingRef

>Hover me

{#if showTooltip}

  


    Tooltip

  

{/if}

```

## API

### Setting Floating UI options

Floating UI options can be set statically when creating the actions, or dynamically on the content action.

If both are set, then the dynamic options will be merged with the initial options.

```svelte

  // set once and no longer updated

  const [ floatingRef, floatingContent ] = createFloatingActions(initOptions);



```

### Updating the Floating UI position

The content element's position can be manually updated by using the third value returned by `createFloatingActions`. This method takes an optional options object which will be merged with the initial options.

```svelte

  // Get update method

  const [ floatingRef, floatingContent, update] = createFloatingActions(initOptions);

  update(updateOptions)

```

### [Floating UI autoUpdate](https://floating-ui.com/docs/autoUpdate)

You can use [autoUpdate options](https://floating-ui.com/docs/autoUpdate#options) directly in initOptions for [createFloatingActions or floatingContent](https://github.com/fedorovvvv/svelte-floating-ui#example), but not in [update](https://github.com/fedorovvvv/svelte-floating-ui#updating-the-floating-ui-position)

```svelte

  import { offset, flip, shift } from "svelte-floating-ui/dom";

  import { createFloatingActions } from "svelte-floating-ui";

  const [ floatingRef, floatingContent ] = createFloatingActions({

    strategy: "absolute",

    placement: "top",

    middleware: [

      offset(6),

      flip(),

      shift(),

    ],

    autoUpdate: { // or false to disable everything

      ancestorResize: false,

      elementResize: false

    }

  });

```

What values can autoUpdate have?

Partial<[Options](https://floating-ui.com/docs/autoUpdate#options)>

```ts

/**

* false: Don't initialize autoUpdate;

* true: Standard autoUpdate values from the documentation;

* object: All as in the autoUpdate documentation. Your parameters are added to the default ones;

* @default true

*/

autoUpdate?: boolean | Partial

```

### [Virtual Elements](https://floating-ui.com/docs/virtual-elements)

**Svelte Floating UI** allows you to use the `floatingRef` (reference node) like [VirtualElement](https://floating-ui.com/docs/virtual-elements)

[Svelte stores](https://svelte.dev/docs#run-time-svelte-store) allow you to make these elements reactive and provide full support for them in the **Svelte Floating UI**

This is an example of creating a tooltip that runs behind the mouse cursor:

```svelte

  import type { ClientRectObject, VirtualElement } from 'svelte-floating-ui/core'

  import { createFloatingActions } from 'svelte-floating-ui'

  import { writable } from 'svelte/store'

  

  const [floatingRef, floatingContent] = createFloatingActions({

    strategy: 'fixed', //or absolute

  })

  let x = 0

  let y = 0

  const mousemove = (ev: MouseEvent) => {

    x = ev.clientX

    y = ev.clientY

  }

  $: getBoundingClientRect = ():ClientRectObject => {

    return {

      x,

      y,

      top: y,

      left: x,

      bottom: y,

      right: x,

      width: 0,

      height: 0

    }

  }

  

  const virtualElement = writable<VirtualElement>({ getBoundingClientRect })

  $: virtualElement.set({ getBoundingClientRect })

  floatingRef(virtualElement)

  
Magic


```

### Applying custom styles on compute

To apply styles manually, you can pass the `onComputed` option to `createFloatingActions`. This is a function that recieves a [`ComputePositionReturn`](https://floating-ui.com/docs/computeposition#return-value). This function is called every time the tooltip's position is computed.

See [Arrow Middleware](#arrow-middleware) for an example on it's usage.

## Arrow Middleware

For convenience, a custom [Arrow middleware](https://floating-ui.com/docs/arrow) is provided. Rather than accepting an `HTMLElement`, this takes a `Writable`. Otherwise, this middleware works exactly as the regular Floating UI one, including needing to manually set the arrow styles.

To set the styles, you can pass the [`onComputed`](#applying-custom-styles-on-compute) option. The below implementation is copied from the [Floating UI Tutorial](https://floating-ui.com/docs/tutorial#arrow-middleware).

```svelte

  import { writable } from "svelte/store";

  import { arrow } from "svelte-floating-ui";

  const arrowRef = writable(null);

  const [ floatingRef, floatingContent, update] = createFloatingActions({

    strategy: "absolute",

    placement: "bottom",

    middleware: [

      arrow({ element: arrowRef })

    ],

    onComputed({ placement, middlewareData }) {

      const { x, y } = middlewareData.arrow;

      const staticSide = {

        top: 'bottom',

        right: 'left',

        bottom: 'top',

        left: 'right',

      }[placement.split('-')[0]];

      Object.assign($arrowRef.style, {

        left: x != null ? `${x}px` : "",

        top: y != null ? `${y}px` : "",

        [staticSide]: "-4px"

      });

    }

  });

 showTooltip = true}

  on:mouseleave={() => showTooltip = false}

  use:floatingRef

>Hover me

{#if showTooltip}

  


    Tooltip this is some longer text than the button

    

  

{/if}

```

_Thanks to [TehNut/svelte-floating-ui](https://github.com/TehNut/svelte-floating-ui) for the foundation for this package_