npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

uxcore-user-guide

v0.2.0

Published

uxcore-user-guide component for uxcore.

Downloads

22

Readme

uxcore-user-guide

React user guide

NPM version build status Test Coverage Dependency Status devDependency Status NPM downloads

Sauce Test Status

Development

git clone https://github.com/uxcore/uxcore-user-guide
cd uxcore-user-guide
npm install
npm run server

if you'd like to save your install time,you can use uxcore-tools globally.

npm install uxcore-tools -g
git clone https://github.com/uxcore/uxcore-user-guide
cd uxcore-user-guide
npm install
npm run dep
npm run start

Test Case

npm run test

Coverage

npm run coverage

Demo

http://uxcore.alibaba.net/components/uxcore-user-guide?type=others

Contribute

Yes please! See the CONTRIBUTING for details.

使用方法

一个产品或者页面中可能有多个引导,需要给每个引导做一个key

const blokingUserGuide = UserGuideFactory.getWithKey('1', {
  // 可以自定义参数
  isBlocking: true,
  assistType: 'SKIP',
  onComplete() {
    /** 引导结束,执行业务逻辑 **/
  },
});
const UserGuide = UserGuideFactory.getWithKey('2', {
  // 可以自定义参数
  isBlocking: false,
  assistType: 'NO_REMIND',
  onAssistClick(step) {
    // 点击 了解更多 / 不再提醒 时的回调函数
    console.log(step);
    // 可以调用 stop 关闭当前引导。
    UserGuide.stop();
    /** 业务逻辑,例如存储不再提醒,下次不要让用户查看相关提醒了。 **/
  },
});

config 种含有的参数包括

| 参数名 | 类型 | 默认值 | 备注 | | --- | --- | --- | --- | | locale | string | 'zh-cn' | 语言 | | prefixCls | string | 'kuma-user-guide' | class 前缀 | | icon | string / React 组件 | undefined | 传递 string 时,以 uxcore-icon 的名字进行渲染;如果为 falsy 的值,则不会渲染;其他直接渲染,不包含外边框。 | | className | string | '' | 定制类名 | | isBlocking | boolean | true | 是否阻塞UI| | assistType | string | undefined | 辅助按钮 / 链接,可选值包括 'SKIP': 跳过; 'LEARN_MORE': 了解更多; 'NO_REMIND': 不再提醒 | | onAssistClick | function | undefined | 了解更多 / 不再提醒 点击时的回调函数 | | onComplete | function | undefined | 结束时的回调 |

然后给这个引导添加步骤,每个步骤可以有4种选择

  • 使用React HOC
const Step1 = UserGuide.addUserGuide({
  dom: 'button',
  step: 1,
  icon: 'shanchu',
  hint: '我是第一步提示',
  type: 'ReactComponent',
});
  • 使用DOM
const Step1 = UserGuide.addUserGuide({
  dom: document.getElementById('app'),
  step: 2,
  hint: '我是第二步提示',
  type: 'HTMLElement',
});
  • 使用一个函数返回DOM
const Step1 = UserGuide.addUserGuide({
  getDom() { return document.getElementById('app'); },
  step: 3,
  hint: '我是第三步提示',
  type: 'HTMLElementMaker',
});
  • 使用图片
UserGuide.addUserGuide({
  step: 4,
  hint: '我是第四步的提示,我也没有对应的DOM',
  type: 'Image',
  top: 1800,
  left: 1000,
  image: 'https://img.alicdn.com/tfs/TB1TRNAllfH8KJjy1XbXXbLdXXa-240-240.png',
  imageHeight: 120,
  imageWidth: 120,
});

需要开始引导时,需要

UserGuide.start();

start 可以传递参数:

| 参数名 | 类型 | 默认值 | 备注 | | --- | --- | --- | --- | | designMode | bool | false | 是否设计模式,如果是true,会展示所有的步骤,以供调试及预览使用。 |

需要关闭时,可以调用

UserGuide.stop();

stop 可以传递参数

| 参数名 | 类型 | 默认值 | 备注 | | --- | --- | --- | --- | | callOnComplete | bool | true | 关闭时是否调用onComplete |