guide-modal-sdk - npm Package Compare versions

Comparing version 0.0.1 to 1.0.1

package.json

 {
   "name": "guide-modal-sdk",
-  "version": "0.0.1",
+  "version": "1.0.1",
   "description": "The embedded js for guide modal",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -192,3 +192,40 @@ # `guide-modal`
 
+### 指引内容抽屉
 
+引入js后，会在window下挂载Drawer类，使用方法：
+```js
+const drawer =  new Drawer({
+  width,
+  afterVisibleChange,
+  stepCode,
+  sectionCode,
+  targetOffset,
+});
+```
+
+方法签名如下：
+
+```js
+/**
+ * @param{number} width: 抽屉组件宽度，默认为884
+ * @param{function} afterVisibleChange: 弹窗动画完成回调函数
+ * @param{string} stepCode: 二级步骤id
+ * @param{string} sectionCode: // 锚点默认选中的章节id
+ * @param{number} targetOffset: // 锚点距离窗口顶部滚动偏移量，默认值为0
+ * @return{undefined} 
+ **/
+interface DrawerConfig {
+  width?: number;
+  afterVisibleChange?: () => void;
+  stepCode: string | number;
+  sectionCode?: string | number;
+  targetOffset?: number;
+}
+
+declare var DrawerType: (config: DrawerConfig) => () => void;
+
+```
+
+
+
 ## changelog
@@ -195,0 +232,0 @@ - v0.0.0: 弹窗新增最大高度设置，超出显示滚动条； 添加通知多个接口；

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

99896

increased by35.59%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

234

increased by18.78%

No dependency changes