Skip to content

Vue plugin that hides or shows elements depending of a criteria. πŸ‘€

Notifications You must be signed in to change notification settings

lewandy/vue-visibility

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Vue Visibility πŸ‘€

Hides or shows elements depending of a criteria.

Install

npm install --save @lewandy/vue-visibility

or

yarn add @lewandy/vue-visibility

Usage

import { createApp } from "vue";
import App from "./App.vue";
import VueVisibility from "@lewandy/vue-visibility";

const application = createApp(App);

application.use(VueVisibility);

application.mount("#app");

Set identifiers or permissions globally

<script>
export default {
  name: "App",
  created() {
    this.$root.$setVisibilityPermissions([121, 122, 123]);
  },
};
</script>

Examples

Using provider with placeholder slot if not authorized

<template>
      <VueVisibilityProvider :identifier="124">
        <template v-slot:placeholder>
          <h2>You don't have access to see this.</h2>
        </template>
        <div class="card"><h2>CARD 1</h2></div>
      </VueVisibilityProvider>
</template>

Using the directive.

<template>
  <div>
    <div v-visibility="123" class="card">
	<h2>CARD 2</h2>
    </div>
  </div>
</template>

VueVisibilityProvider component reference

Prop Type Required Default
identifier Any true null

TODO

  1. Feature : Can disable elements and make it not clickable.
  2. Chore : Write basic tests

🀝 Contributing

  1. Fork this repository.
  2. Create new branch with feature name.
  3. Go to example folder and run npm install and npm run serve.
  4. The plugin sources files is located in /src/VueVisibility.js.
  5. Commit and set commit message with feature name.
  6. Push your code to your fork repository.
  7. Create pull request. πŸ™‚

⭐️ Support

If you like this project, You can support me with starring ⭐ this repository.

πŸ“„ License

MIT

Developed with ❀️ and β˜•οΈ from the dominican republic 🌴

About

Vue plugin that hides or shows elements depending of a criteria. πŸ‘€

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published