Revel
GitHub
GitHub
  • Overview

    • Getting started
    • FAQ
    • Release notes
  • Foundations

    • Meet the standard
    • Accessibility
    • Internationalization
    • Information hierarchy
    • Speed
  • Design

    • Visual principles
    • Colors
    • Space
    • Icons
    • Typography
  • Design tokens
  • Style helpers
  • Content

    • Express your ideas
    • Actionable language
    • Inclusive and accessible language
    • Alternative text
    • Grammar and mechanics
      • Basics
      • Capitalization
      • Dates and units of measurement
      • Punctuation
  • Components

    • Alert
    • Avatar
    • Badge
    • Button
    • Button group
    • Checkbox
    • Date Input
      • dates
      • datetimes
      • ranges
    • Field group
    • File upload
    • Flex
    • Grid
    • Icon
    • Image
    • Input
    • Loader
    • Modal
    • Month picker
    • Pagination
    • Popper
    • Radio
    • Repeater
    • Select
    • Tabs
    • Tile
    • Toast
    • Toggle
  • Directives

    • Click outside
    • Tooltip

Popper

The r-popper is a versatile component that displays any content using any trigger. Easily customize and manage pop-up content to enhance your user interactions.

Usage

import { RPopper } from '@rebilly/revel';

<r-popper :auto-hide="true">
    <template v-slot:trigger="scope">
        <r-button @click="scope.popper.toggle">
            Click me
        </r-button>
    </template>
    <template v-slot:content>
        <div class="r-popover">
            <div class="r-popover-control">
                <div class="r-popover-content r-popover-menu">
                    <a class="r-popover-menu-item">
                        List item #1
                    </a>
                    <a class="r-popover-menu-item">
                        List item #2
                    </a>
                </div>
            </div>
        </div>
    </template>
</r-popper>

Examples

popper-icon-button.vue
popper-button.vue
popper-margin.vue

API

Props

NameTypeDefaultDescription
stateNullable, booleannull

Opens popper with the parent component

escToHidebooleantrue

Close popper on escape key press

autoHidebooleantrue

Close popper automatically

globalAutoHidebooleantrue

Close all poppers automatically

closeFunctionNullable, TSFunctionTypenull

Function to run when closing the popper

openOnMountbooleanfalse

Open popper on mount

disabledbooleanfalse

Disable popper

fluidbooleanfalse

Fluid popper layout

offsetnumber4

Offset from the trigger element

marginMarginsOffset() => [0, 0, 0, 0]

Margin from the trigger element (ignored on mobile)

directionDirections'horizontal'

Popper direction

positionPositions'bottomStart'

Popper position

slideFromSlideFrom'fade'

Slide from direction

durationnumber0.2

Transition duration

strategyStrategy'absolute'

Strategy for positioning the popper. By default it's `absolute` but you can use `fixed` to position the popper relative to the window.

Slots

NameDescription
trigger

Popper trigger element.

content

Popper content element.

Events

NameDescription
setActivePopper
toggle
toggle-on
toggle-off
Edit this page
Last Updated: 7/29/24, 6:48 PM
Contributors: Dasha Baklanova, John Hannagan, Weetbix, Cesar Level
Prev
Pagination
Next
Radio