# hs-public-head

> 寰烁公用头部底部

Latest version **0.1.6** (published 2022-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install hs-public-head
pnpm add hs-public-head
yarn add hs-public-head
bun add hs-public-head
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2022-12-07 |
| First published | 2022-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 633.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | ZHUKUN |
| Maintainers | zhukun |

## Links

- npm: https://www.npmjs.com/package/hs-public-head
- npm.io page: https://npm.io/package/hs-public-head

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.6.10
- [ant-design-vue](https://npm.io/package/ant-design-vue.md) ^1.6.5

## Recent versions

- 0.1.6 (latest) — 2022-12-07
- 0.0.7 — 2022-12-07
- 0.1.5 — 2022-12-07
- 0.1.4 — 2022-12-02
- 0.0.6 — 2022-12-02
- 0.1.3 — 2022-11-16
- 0.0.5 — 2022-11-16
- 0.1.2 — 2022-09-16
- 0.1.1 — 2022-09-15
- 0.0.4 — 2022-07-27
- 0.0.3 — 2022-07-22
- 0.0.2 — 2022-07-22
- 0.0.1 — 2022-07-22

## README

# hs-public-head

## 引入文件

``` html
<jsheader :seachOption="['选项1' ,'选项2']" :spaceTitle="'头部组件'" :searchUrl="searchUrl" @logout="logout" @toNewsDetail='toNewsDetail' @conflict='conflict' > <!-- ... -->
    <span slot="spaceTitle">我是插槽</span>
    <span slot="worktableReplace">我是插槽2</span>
    <span slot="endSlot">我是插槽3</span>
</jsheader>
<jsfooter />
<script>
    import base from "hs-public-head";
    import 'hs-public-head/js-base/js-base.css';
    Vue.use(base);
    export default {
        methods: {
            logout(e) {
                // do something
            },
            toNewsDetail(e) {
                e // { id, messageType, parmes } 消息id 消息类型 消息参数信息
            },
            conflict() {
                // 清除缓存等操作
            }
        }
    }
</script>
```

## 注意事项
### 1. 发布版本时请注意header、footer组件的version参数
### 2. 点击退出登录，继续登录后跳转地址为logoutUrl参数
### 3. 退出参数clientId请咨询后台
### 4. 用户被挤掉线时，弹窗关闭会触发conflict事件，建议在事件内进行清除缓存等操作 
### 5. 本地开发时，如果需要头部正常显示，获取到用户信息，version传参可改为local
### 6. 头部默认为同步加载，将先获取头部信息并阻塞js进程 ，如不需要传isAsync = true
## header

### 参数

|        参数         |                                  说明                                  |            类型             |              默认值              |
|:-------------------:|:----------------------------------------------------------------------:|:---------------------------:|:--------------------------------:|
|     appId      |                                应用ID                                 | ` String \| Number ` |                            |
|     spaceTitle      |                                头部标题                                 | ` String \| slot ` |                            |
| worktableReplace | 新增的插槽，在工作台旁边 | ` slot ` |  |
|    isShowSearch     |                             是否显示搜索框                              | ` Boolean ` | `true` |
|    searchOption     |                             搜索框下拉列表                              | ` Array ` | ` [{name: '用户', value: 'person'}, {name: '空间', value: 'space'}]` |
| searchOpenNewWindow |                          搜索時是否打開新窗口                            | ` Boolean ` | `false` |
|      logoutUrl      | 退出后继续登录跳转地址. 详见寰烁统一认证平台OAuth接入文档---2.5主动退出      | ` String ` |     http://pls.hseduyun.net      |
|      clientId       |                            退出参数clientId                            | ` String \| Number ` |               demo               |
|     isShowWork      |                           是否显示工作台入口                             | ` Boolean ` | ` true ` |
|     isShowNews     |                           是否显示消息铃铛                             | ` Boolean ` | ` true ` |
|    swichRoleUrl     |                           切换角色后跳转地址                           | ` String ` |         默认当前页面地址         |
|     userAvatar      |                                用户头像                                | ` String ` |                                  |
|      reLogin        |        是否开启自动校验登录状态功能，异常状态将执行点击退出登录事件         | ` Boolean ` |        ` false `                         |
|      version        |       环境变量<br>test:测试域名<br>demo:演示域名<br>formal:正式域名<br> local: 本地开发模式      | ` String ` |        test           |
|      LoginBtn       |       校检登录失败时 是否显示登录按钮和点击登录时事件<br> { isShow: true, clickAutoToLogin: true },isShow为true将显示登录按钮,clickAutoToLogin为true点击登录会自动跳转到登录页。点击登录时触发login事件    | ` object ` |        `{ isShow: true, clickAutoToLogin: true }`           |
|    conflictUrl      |                          用户被挤掉线后继续登录跳转地址                    |  ` String ` |    默认为当前页面地址     |               
|      protocol       |                          压测时切换http、http用                           | ` String `  |   https |
|     workTableUrl    |                           工作台跳转链接                                  |  ` String ` | 先passport验证再回工作台 |
|       endSlot       | 新增插槽，在最后面 | ` slot ` |  |
|       isHideBG       | 是否隐藏头部背景 | ` Boolean ` | ` false ` |
|       opacityBG       | 头部白条背景透明度 | ` String \| Number ` | .6 |
|       isAsync       |   头部是否为异步加载 false将先获取头部信息并阻塞js进程 |  ` Boolean ` | ` false `|
|       isPostUserMes       |   是否关闭埋点 |  ` Boolean ` | ` true `|
|       urlConfig       |   增加小型化并增加自行配置参数 <br>pls_fr: '个人空间前端域名', pls_bk: '个人空间后端域名', nc_fr: '消息中心前端', ph_fr: '个人主页前端', passport: 'passport', plsClientId: '个人空间前端clientid', wss: 'wss', |  ` Boolean ` | ` true `|
### 事件

|   事件名称   |        说明        |         回调参数         |
|:------------:|:------------------:|:------------------------:|
| toNewsDetail | 点击铃铛内消息触发 | ` Function (id, messageType, item ) ` |
|    logout    |  点击退出账号触发  | ` Function ` |
|    login     |    点击登录触发   | ` Function ` |
|  roleSwitch  |  点击切换角色触发  | ` Function ` |
|    conflict  |  用户被挤掉线关闭弹窗触发 | ` Function ` | 
## footer 

### 参数

|   参数    |       说明       |        类型        |           默认值           |
|:---------:|:----------------:|:------------------:|:--------------------------:|
| tenantId  |      租戶id      | ` String ` |                            |
| version | 环境变量<br>test:测试域名<br>demo:演示域名<br>formal:正式域名<br> local: 本地开发模式 <br> xx: 小型化部署  | ` String ` | test |

## 版本更新日志 
#### 版本v0.3.11(2021年12月20日)
    1. 省平台部署，其他环境不可用
#### 版本v0.2.93(2021年1月21日)
    1. 增加 saveaccessToken 接口
#### 版本v0.2.87(2021年1月21日)
    1. 登录改网关服务
#### 版本v0.2.80(2021年12月15日)
    1. 个人主页动态域名
#### 版本v0.2.68(2021年12月08日)
    1. 微服务+多租户
#### 版本v0.2.53(2021年9月23日)
    1. 小型化部署
#### 版本v0.2.52(2021年9月18日)
    1. 小型化部署
    2. 增加可配置域名参数，每个域名自行配置
#### 版本v0.2.51(2021年2月23日)
    1. 万柏林环境
#### 版本v0.2.48(2021年2月23日)
    1. 修改测试环境域名
#### 版本v0.2.47(2021年1月19日)
    1. 修改样式
#### 版本v0.2.46(2021年1月18日)
    1. 修改头部埋点接口修改 accessToken 不需要
#### 版本v0.2.44(2021年1月18日)
    1. 修改头部埋点方式
#### 版本v0.2.43(2021年1月16日)
    1. 更换底部链接
#### 版本v0.2.42(2021年1月15日)
    1. 改回底部id
#### 版本v0.2.41(2021年1月15日)
    1. 写死除了生产环境下底部信息（有些域名请求不到）
#### 版本v0.2.40(2021年1月15日)
    1. 增加埋点， 修改部分样式类名
#### 版本v0.2.39(2021年1月13日)
    1. 暂时屏蔽埋点
#### 版本v0.2.37(2021年1月13日)
    1. 修改埋点时间类型
#### 版本v0.2.37(2021年1月13日)
    1. 增加埋点类型
#### 版本v0.2.36(2021年1月13日)
    1. 修复埋点bug
#### 版本v0.2.35(2021年1月13日)
    1. 增加yctest环境域名
#### 版本v0.2.34(2021年1月12日)
    1. 增加底部备案号超链接
#### 版本v0.2.33(2021年1月11日)
    1. 修改接口请求方式
#### 版本v0.2.32(2021年1月11日)
    1. 修复bug
#### 版本v0.2.30(2021年1月11日)
    1. 增加埋点操作 传参accessToken
#### 版本v0.2.28(2021年1月11日)
    1. 修复bug
#### 版本v0.2.27(2021年1月11日)
    1. 增加搜索按钮
#### 版本v0.2.26(2021年1月7日)
    1. 修复同步bug
#### 版本v0.2.25(2021年1月6日)
    1. 增加同步配置
#### 版本v0.2.21 -- v0.2.24(2020年12月10日)
    1. 增加ptest配置
#### 版本v0.2.20(2020年12月10日)
    1. 增加mac电脑谷歌浏览器软件下载地址
#### 版本v0.2.16(2020年12月10日)
    1. 调整浏览器提示
#### 版本v0.2.15(2020年12月10日)
    1. 修改被挤下线时跳转地址
#### 版本v0.2.13(2020年11月20日)
    1. 修改上海、本地配置
#### 版本v0.2.10(2020年11月17日)
    1. 上海项目配置修改
#### 版本v0.2.9(2020年11月17日)
    1. 上海项目隐藏消息铃铛
#### 版本v0.2.8(2020年11月17日)
    1. 修改底部上海配置
#### 版本v0.2.7(2020年11月16日)
    1. 修改上海配置
#### 版本v0.2.5(2020年11月14日)
    1. 可选择隐藏头部背景
    2. 可调整头部白条背景透明度
#### 版本v0.2.4(2020年11月10日)
    1. 可选择隐藏消息铃铛
#### 版本v0.2.3(2020年11月03日)
    1. 使用css代替图片
#### 版本v0.2.2(2020年11月03日)
    1. 优化提示
#### 版本v0.1.8(2020年11月02日)
    1. 点击登录无效bug
#### 版本v0.1.7(2020年11月02日)
    1. 断线重连5次提示登录状态过期
#### 版本v0.1.5(2020年10月29日)
    1. 离线状态
#### 版本v0.1.3(2020年10月10日)
    1. 使用缓存时底部信息接口错误bug
#### 版本v0.1.2(2020年10月10日)
    1. 修复用户名受默认样式影响
#### 版本v0.1.1(2020年9月29日)
    1. 新增插槽，位置在尾部
#### 版本v0.1.0(2020年9月28日)
    1. 极大减小头部体积
    2. 兼容ie11等其他浏览器
    3. 其他优化
#### 版本v0.0.85(2020年9月23日)
    1. 可修改工作台跳转链接
#### 版本v0.0.84(2020年9月22日)
    1. 修改底部链接
#### 版本v0.0.83(2020年9月17日)
    1. 搜索优化
#### 版本v0.0.82(2020年8月28日)
    1. 消息默认数为bug
#### 版本v0.0.79, 版本v0.0.78, 0.0.80, 0.0.81(2020年8月27日)
    1. 版本发布错误修改
#### 版本v0.0.76 (2020年8月27日)
    1. WebSocket断网设置
    2. 被挤掉线时跳转地址修改
#### 版本v0.0.75 (2020年8月26日) (测试阶段)
    1. 极大减少包体积
    
#### 版本v0.0.74 (2020年8月19日)
    个人空间演示环境后台地址
#### 版本v0.0.73 (2020年8月19日)
    1. 配置底部demo环境地址
#### 版本v0.0.72 (2020年8月19日)
    1. 配置增加demo环境地址
#### 版本v0.0.71 (2020年8月14日)
    1. 修复用户被挤下线还会继续请求接口bug
#### 版本v0.0.70 (2020年8月13日)
    1. WebSocket自动重连 
    2. 缓存处理more
#### v0.0.69: 缓存处理
#### v0.0.66: sessionid存放
#### v0.0.65: 用户被挤下线提示，压测时可切换passport域名的http -> https
#### v0.0.64: 头部名字可显示4个字，单角色按钮隐藏
#### v0.0.63: 消息铃铛字段取错bug
#### v0.0.62: 单一角色不需要显示用户角色
#### v某个版本: 新增插槽worktableReplace

---
_Source: https://npm.io/package/hs-public-head · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
