Git Product home page Git Product logo

svelte-popper's Introduction

@popperjs/svelte

Use Popper in your Svelte projects.

Installation

yarn add @popperjs/svelte
# or
npm i @popperjs/svelte

Usage

<script>
  import Popper from "@popperjs/svelte";

  // super-simple CSS Object to string serializer
  const css = obj =>
    Object.entries(obj || {})
      .map(x => x.join(":"))
      .join(";");

  // DOM references to the interested elements
  let referenceElement;
  let popperElement;
  let arrowElement;

  // Popper options, reactive to update when arrowElement is set
  $: popperOptions = {
    modifiers: [
      { name: "offset", options: { offset: [0, 5] } },
      { name: "arrow", options: { element: arrowElement } }
    ]
  };

  // bound variables where Popper will store styles and attributes
  let styles = {};
  let attributes = {};

  console.log(styles);
</script>

<style>
  /* for some example styles, see `dev/App.svelte` */
</style>

<Popper
  reference={referenceElement}
  popper={popperElement}
  options={popperOptions}
  bind:styles
  bind:attributes>
  <button bind:this={referenceElement}>Reference Element</button>
  <div
    bind:this={popperElement}
    class="tooltip"
    style={css(styles.popper)}
    {...attributes.popper}>
    Popper Element
    <div bind:this={arrowElement} class="arrow" style={css(styles.arrow)} />
  </div>
</Popper>

svelte-popper's People

Contributors

fezvrasta avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

svelte-popper's Issues

use:popper action (instead of component based API)

The existing <Popper /> component doesn't feel right, it does absolutely nothing, if not allow the consumers to pass props down and retrieve the result.

The README example could be written as follows and everything would still work:

<Popper
  reference={referenceElement}
  popper={popperElement}
  options={popperOptions}
  bind:styles
  bind:attributes
/>

<button bind:this={referenceElement}>Reference Element</button>
<div
  bind:this={popperElement}
  class="tooltip"
  style={css(styles.popper)}
  {...attributes.popper}>
  Popper Element
  <div bind:this={arrowElement} class="arrow" style={css(styles.arrow)} />
</div>

A cleaner approach could be the use:action API.

<script>
  let styles = {};
  let attributes = {};
</script>

<button
  use:popper={{ popperElement, options }}
  on:popperUpdate={evt => {
    styles = evt.detail.styles;
    attributes = evt.detail.attributes;
  }}
>
  Reference Element
</button>

Here's a basic example:
https://codesandbox.io/s/trusting-butterfly-704gd?file=/popperAction.js

Thoughts?

TypeError: placement.split is not a function

Hello, following the example given in the README and I keep getting the following error:

getBasePlacement.js:3 Uncaught (in promise) TypeError: placement.split is not a function
    at getBasePlacement (getBasePlacement.js:3)
    at distanceAndSkiddingToXY (offset.js:4)
    at offset.js:31
    at Array.reduce (<anonymous>)
    at offset (offset.js:30)
    at Object.forceUpdate (createPopper.js:183)
    at createPopper.js:196
    at new Promise (<anonymous>)
    at createPopper.js:195
    at debounce.js:8

When I try to debug this, the placement variable comes back as Window at some point (vs a string as it seems to expect)

My component code:

<script lang="ts">
  import Popper from '@popperjs/svelte'
  import { fly } from 'svelte/transition'
  import { quadOut, quadIn } from 'svelte/easing'

  const inProps = { y: 10, duration: 200, easing: quadIn }
  const outProps = { y: -10, duration: 100, easing: quadOut, delay: 100 }

  // super-simple CSS Object to string serializer
  const css = (obj) =>
    Object.entries(obj || {})
      .map((x) => x.join(':'))
      .join(';')

  // DOM references to the interested elements
  let referenceElement
  let popperElement
  let arrowElement

  // Popper options, reactive to update when arrowElement is set
  $: popperOptions = {
    modifiers: [
      { name: 'offset', options: { offset: [0, 5] } },
      { name: 'arrow', options: { element: arrowElement } },
    ],
  }

  // bound variables where Popper will store styles and attributes
  let styles = {} as any
  let attributes = {} as any

  console.log(styles)
</script>

<Popper reference={referenceElement} popper={popperElement} options={popperOptions} bind:styles bind:attributes>
  <div bind:this={referenceElement}>
    <slot name="trigger" />
  </div>

  <div bind:this={popperElement} class="tooltip" style={css(styles.popper)} {...attributes.popper}>
    <div class={`w-auto bg-white rounded elevation-3`} in:fly={inProps} out:fly={outProps}>
      <slot />
    </div>
    <div bind:this={arrowElement} class="arrow" style={css(styles.arrow)} />
  </div>
</Popper>

Other info
Node version: v12.19.0
Svelte version: 3.29.0
"@popperjs/svelte": "^0.1.1"

Thank you in advance

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.