https://github.com/crazymryan/v2-permission

一个 Vue 权限指令
https://github.com/crazymryan/v2-permission

v-permission vue vue3

Last synced: about 1 month ago
JSON representation

一个 Vue 权限指令

• Host: GitHub
• URL: https://github.com/crazymryan/v2-permission
• Owner: CrazyMrYan
• Created: 2023-07-25T14:50:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-26T03:01:03.000Z (almost 2 years ago)
• Last Synced: 2025-03-14T23:04:30.450Z (2 months ago)
• Topics: v-permission, vue, vue3
• Language: JavaScript
• Homepage:
• Size: 17.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# v2-permission

[![Publish Package to npmjs](https://github.com/CrazyMrYan/v2-permission/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/CrazyMrYan/v2-permission/actions/workflows/npm-publish.yml)

## 快速上手

### 安装

```shell

npm install v2-permission

```

### 引入

```javascript

import Vue from 'vue';

import permissions from 'v2-permission';

Vue.use(permissions, {

  // 权限 API

  getPermissionsApi: async () => fetch(`/api.json?t=${new Date().getTime()}`).then((res) => res.json()),

});

```

### 使用

```html

新增&编辑

删除

```

## API

### options

| 参数名                 | 类型         | 必填  | 描述                   |

| ------------------- | ---------- | --- | -------------------- |

| `getPermissionsApi` | `Function` | 是   | 获取权限的方法              |

| `checkPermission`   | `Function` | 否   | 检查权限的方法              |

| `name`              | `String`   | 否   | 自定义指令名称              |

| `className`         | `String`   | 否   | 自定义指令隐藏时添加的 class 名称 |

## 详细内容

### 期望接口返回值

> 如果接口不确定是否能够给你这种格式，你可以选择转一下，或者自己写一个checkPermission。

```json

{

    "orders": [

        "add",

        "update",

        "delete",

        "query",

        "detail",

        "enable",

        "disable"

    ]

}

```

### 自定义 checkPermission

> 你如果需要自定义需求，可以在 Use 时传入 `checkPermission`这样就会将内置的内容覆盖掉，注释如下，接受 value，返回 Boolean。

```js

/**

 * @name checkPermission

 * @param { String | Array } value 权限指令的 value

 * @returns { Boolean } 是否有权限

 */

```