Introducing vue-float-menu, A Smart floating Menu for Vue 3.

vue-float-menu

I've been pretty excited about the Vue 3 release lately and was thinking about writing a new component library for Vue 3.

I was badly in need of a draggable floating menu for some of my projects. Although there are some great projects on github targeting Vue 2, I could not find one that could satisfy some of my UX & functional needs.

vue-float-menu is an attempt to create such a flexible menu that can be easily dragged around on the screen with support for sub menus.

Please feel free to send in any feedbacks you have regarding the project or any issues you face while trying out.

⚡ Edit on Stackblitz

⭐ Star this Project

prabhuignoto / vue-float-menu

🎈Customizable floating menu for Vue

Features

✅ Draggable Menu Handle - Drag and easily place the Menu anywhere on screen.

✅ Smart Menu - Detects the top & bottom edges of the screen and flips the menu automatically.

✅ Smart Placement - The Menu head automatically adjusts itself and always stays inside the viewport.

✅ Nested Menus - Support for Nested menus up to any levels.

✅ Composition API - Built using the latest Composition API from Vue 3.

⚙ Installation

yarn install vue-float-menu

🚀 Getting Started

float-menu has some great defaults. Please check the props list for details on all available options.

The following snippet sets the default position of the menu as top left and default menu direction as bottom.

  <float-menu
    position="top left"
    :dimension="50"
    :menu="menuData"
    menu-direction="bottom"
  >
    <BoxIcon />
  </float-menu>

📺 Demo

Props

Prop	Type	Description
dimension	number	dimension of the Menu Head width x height in pixels.
position	String	Initial position of the Menu Head. can be any one of the values top left, top right, bottom left, bottom right
fixed	Boolean	Disables dragging and the Menu will be fixed. use the position prop to fix the menu position
menu-orientation	String	Set's the Menu's orientation. can be top or bottom.
menu-dimension	Object	Set's the width and minimum height of the Menu.
menu-data	Object	Array data to generate the nested menu's.
on-selected	Function	Hook that is called on selection.
flip-on-edges	Boolean	Flips the Menu content automatically, when there is no space to display nested menus.

Dimension

dimension prop can be used to set the width and height of the menu head. The prop takes a single number value to set the height and width of the Menu Head.

  <float-menu :dimension=50>
    <BoxIcon />
  </float-menu>

Position

The position prop can be used to set the initial position of the Menu Head. The prop can accept any one of the following values.

• top left (default)
• top right
• bottom left
• bottom right

  <float-menu :dimension=50 position="bottom right">
    <BoxIcon />
  </float-menu>

Fixed position

To disable dragging and to fix the position statically, set fixed to true. This prop is disabled by default. Use this prop along with the position prop to set the desired position.

  <float-menu :dimension=50 position="bottom right" fixed>
    <BoxIcon />
  </float-menu>

Menu orientation

sets the default orientation of the menu. can be set to either top or bottom.

  <float-menu :dimension=50 position="bottom right" menu-orientation="bottom">
    <BoxIcon />
  </float-menu>

Menu head dimension

prop to set the height and width of the menu.

  <float-menu
    :dimension=50
    :menu-dimension="{height: 400, width: 300}"
    position="bottom right"
    menu-orientation="bottom"
    <BoxIcon />
  </float-menu>

Populating Menu

Use the menu-data prop to create Simple or Nested menus of your liking. menu-data takes an array of MenuItem type

List of MenuItem properties

property	description
name	display name of the menu item.
id	unique id of each menu item. this is auto generated by the component.
selected	flag to highlight a sub-menu selection.
showSubMenu	flag to show/hide the sub-menu.
subMenu	data for the sub-menu

Here we create a simple Menu structure with 3 Menu items with no sub menus.

const menuData = [
  { name: "New" },
  {
    name: "Edit",
    subMenu: {
      name: "edit-items",
      items: [{ name: "Copy" }, { name: "Paste" }],
    },
  },
  {
    name: "Open Recent",
    subMenu: {
      name: "recent-items",
      items: [{ name: "Document 1" }, { name: "Document 2" }],
    },
  },
]

  <float-menu
    :dimension=50
    :menu-dimension="{height: 400, width: 300}"
    :menu-data="menuData"
    position="bottom right"
    menu-orientation="bottom">
    <BoxIcon />
  </float-menu>

on-select

hook for the menu item selection event.

  <float-menu
    :dimension=50
    position="bottom right"
    :menu-dimension="{height: 400, width: 300}"
    :menu-data="{items: [{name: 'File'}, {name: 'Open'}]}"
    on-select="handleSelection"
    menu-orientation="bottom">
    <BoxIcon />
  </float-menu>

Auto flip on edges

setting this prop flips the menu content on the right edges of the screen. This is useful you have nested menus of many levels.

  <float-menu
    :dimension=50
    position="bottom right"
    flip-on-edges
    on-select="handleSelection"
    menu-orientation="bottom">
    <BoxIcon />
  </float-menu>

Custom icon

To customize the Menu Icon, simply pass any content in between the float-menu tags. Here we render a custom icon.

  <float-menu
    :dimension=50
    :menu-data="menuData"
    menu-orientation="bottom">
    <BoxIcon />
  </float-menu>

and here we render a custom text inside the Menu handle

  <float-menu
    :dimension=50
    :menu-data="menuData"
    menu-orientation="bottom">
    Click
  </float-menu>

🔨 Built with

• Vue.JS - The Component is written in Vue + Typescript.

📄 Notes

• The project uses vite instead of @vue/cli. I choose vite for speed and i also believe vite will be the future.

Meta

Prabhu Murthy – @prabhumurthy2 – [e-mail]

https://www.prabhumurthy.com

Distributed under the MIT license. See LICENSE for more information.

https://github.com/prabhuignoto/float-menu

If you like this project, show some love. ⭐ Star this Project