asf-navbar

使用

通过包管理器安装:

# Installation with npm
npm install asf-navbar -D
# or with yarn
yarn add asf-navbar -D

React Demo

import { ReactNavBar } from 'asf-navbar';

export default () => {
  return (
    <div>
      <ReactNavBar/>
    </div>
  )
}

Vue Demo

<template>
  <div class="parent-element">
    <vue-nav-bar :config="conf" :proj="'实用工具'" :activate-call-back="callback" ></vue-nav-bar>
  </div>
</template>
<script>
import { VueNavBar } from './node_modules/asf-navbar';
  export default {
    components:{
        VueNavBar
    },
    data() {
      return {
        conf: {
          elementaryBar: "实用工具",
          secondaryBars: [
            {name: "枝网查重", link: "https://www.baidu.com"},
            {name: "成分姬", link: "https://www.baidu.com"},
            {name: "表情包", link: "https://www.baidu.com"},
            {name: "方言词典", link: "https://www.baidu.com"},
          ]
        }
      }
    },
    methods:{
        callback(str){
            window.open(str);
            console.log(str);
        }
    }
  }
</script>

开发

# 运行前安装
yarn install

# 调试
yarn serve:vue    # 查看 vue 组件
yarn serve:react  # 查看 react 组件

# 打包
yarn build        # 构建项目

# 代码检测
yarn lint

# 发布至 npm
yarn release:publish

API

| 参数 | 说明 | 类型 | 默认值 | | ---- | ---- | ---- | ---- | |config| 导航栏设置 | Object| - | | proj | 项目名 | String| - | | activate-call-back | 子菜单点击后触发的回调函数 | Function| function openInNewTab(str){window.open(str)} |

项目地址

https://gitee.com/asoul-fan/asf-navbar-vue

环境

• 使用 Node.js 14.17.5 官网LTS版本

Commit时备注

• 增加从未有过的功能，即新增功能性提交：<feat>: +提交说明
• 不改变功能，即新增非功能性提交： <refactor>: +提交说明
• 优化之前的代码，即更新功能性提交： <update>: +提交说明
• 提交说明可以使用中文

分支规范

多分支开发遵从 GITFLOW 规范

GIT提交规范

• 提交前会自动启动 Git Hook 调用 husky + yarn lint，若检测到有任何语法错误或 typo 会阻止提交。

• 为避免全局配置中的邮箱或姓名带有盒信息，请修改全局 Git 配置或在具体项目根目录下使用以下命令修改 Git 提交信息

  git config user.name "xxxx"
  git config user.email "[email protected]"

代码规范

• 变量命名优先遵循eslint+babel自带规范,若无提示,默认使用驼峰命名法(camelCase)
• 请不要随意格式化他人的文件
• 在引入非官方依赖前需要联系负责人确认
• 新人提交的代码需要进行code review