Socket
Socket
Sign inDemoInstall

@jledentu/vue-finder

Package Overview
Dependencies
22
Maintainers
1
Versions
51
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jledentu/vue-finder

A Vue.js component to display hierarchical data


Version published
Maintainers
1
Weekly downloads
499
decreased by-13.37%

Weekly downloads

Readme

Source

Vue Finder

A Vue 3 component to display hierarchical data (like the MacOS X finder)

Build Status Npm badge Codecov CodeFactor semantic-release

Screenshot

Documentation

The documentation is available on the website.

Getting Started

npm install --save @jledentu/vue-finder

An example of Vue Single File component:

<template>
  <Finder :tree="tree" />
</template>
<script>
  import { Finder } from "@jledentu/vue-finder";

  export default {
    components: {
      Finder,
    },
    data() {
      return {
        tree: {
          id: "root",
          children: [
            {
              id: "fruits",
              label: "Fruits",
              children: [
                {
                  id: "apple",
                  label: "Apple",
                  selectable: false,
                },
                {
                  id: "banana",
                  label: "Banana",
                },
                {
                  id: "grape",
                  label: "Grape",
                  selected: true,
                },
                {
                  id: "lemon",
                  label: "Lemon",
                  selectable: false,
                },
                {
                  id: "orange",
                  label: "Orange",
                  selected: true,
                },
              ],
            },
            {
              id: "vegetables",
              label: "Vegetables",
              children: [
                {
                  id: "bean",
                  label: "Beans",
                },
                {
                  id: "carrot",
                  label: "Carrot",
                  selected: true,
                },
                {
                  id: "eggplant",
                  label: "Eggplant",
                  selectable: false,
                },
                {
                  id: "parsnip",
                  label: "Parsnip",
                },
                {
                  id: "tomato",
                  label: "Tomato",
                  selectable: false,
                },
              ],
            },
          ],
        },
      };
    },
  };
</script>

<style src="@jledentu/vue-finder/dist/vue-finder.css" />

Browser

You can also include the standalone UMD build in your page from the jsdeliver CDN. Make sure to import Vue as a dependency before vue-finder.

<html>
  <head>
    <!-- Include Vue 3.x -->
    <script src="https://cdn.jsdelivr.net/npm/vue@^3"></script>
    <!-- Include vue-finder & its styles -->
    <script src="https://cdn.jsdelivr.net/npm/@jledentu/vue-finder@next/dist/vue-finder.umd.js"></script>
    <link
      rel="stylesheet"
      href="https://cdn.jsdelivr.net/npm/@jledentu/vue-finder@next/dist/vue-finder.css"
    />
  </head>

  <body>
    <div id="app">
      <Finder :tree="tree" />
    </div>
  </body>
  <script>
    const { createApp } = Vue;

    createApp({
      components: {
        Finder: Finder.Finder,
      },
      data() {
        return {
          tree: {
            id: "root",
            children: [
              {
                id: "fruits",
                label: "Fruits",
                children: [
                  {
                    id: "apple",
                    label: "Apple",
                    selectable: false,
                  },
                  {
                    id: "banana",
                    label: "Banana",
                  },
                  {
                    id: "grape",
                    label: "Grape",
                    selected: true,
                  },
                  {
                    id: "lemon",
                    label: "Lemon",
                    selectable: false,
                  },
                  {
                    id: "orange",
                    label: "Orange",
                    selected: true,
                  },
                ],
              },
              {
                id: "vegetables",
                label: "Vegetables",
                children: [
                  {
                    id: "bean",
                    label: "Beans",
                  },
                  {
                    id: "carrot",
                    label: "Carrot",
                    selected: true,
                  },
                  {
                    id: "eggplant",
                    label: "Eggplant",
                    selectable: false,
                  },
                  {
                    id: "parsnip",
                    label: "Parsnip",
                  },
                  {
                    id: "tomato",
                    label: "Tomato",
                    selectable: false,
                  },
                ],
              },
            ],
          },
        };
      },
    }).mount("#app");
  </script>
</html>

Changelog

See the GitHub release history.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

Development scripts

  • yarn build to build the library
  • yarn test to run the unit tests
  • yarn storybook to run the Storybook in watch mode
  • yarn docs:dev to run the Vuepress documentation in watch mode

Credits

License

MIT

Keywords

FAQs

Last updated on 05 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc