@kc-one/smart-fill-sdk 0.0.1-beta.1 → 0.0.1-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -5
- package/dist/index.esm.js +2754 -890
- package/dist/index.umd.cjs +28 -19
- package/dist/src/adapters/element.d.ts +3 -0
- package/dist/src/adapters/element.d.ts.map +1 -0
- package/dist/src/adapters/ui-framework.d.ts +5 -0
- package/dist/src/adapters/ui-framework.d.ts.map +1 -0
- package/dist/src/client/gateway-client.d.ts.map +1 -1
- package/dist/src/config/defaults.d.ts +1 -1
- package/dist/src/config/defaults.d.ts.map +1 -1
- package/dist/src/core/smart-fill-instance.d.ts +25 -1
- package/dist/src/core/smart-fill-instance.d.ts.map +1 -1
- package/dist/src/core/smart-fill.d.ts.map +1 -1
- package/dist/src/filler/dom-filler.d.ts.map +1 -1
- package/dist/src/index.d.ts +6 -5
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/rules/local-rules.d.ts.map +1 -1
- package/dist/src/scanner/dom-scanner.d.ts +7 -1
- package/dist/src/scanner/dom-scanner.d.ts.map +1 -1
- package/dist/src/scanner/ui-frameworks.d.ts +38 -0
- package/dist/src/scanner/ui-frameworks.d.ts.map +1 -0
- package/dist/src/select/address-cascader.d.ts +13 -0
- package/dist/src/select/address-cascader.d.ts.map +1 -0
- package/dist/src/select/custom-select.d.ts +19 -0
- package/dist/src/select/custom-select.d.ts.map +1 -0
- package/dist/src/select/option-match.d.ts +14 -0
- package/dist/src/select/option-match.d.ts.map +1 -0
- package/dist/src/select/select-fill.d.ts +4 -0
- package/dist/src/select/select-fill.d.ts.map +1 -0
- package/dist/src/types/index.d.ts +33 -5
- package/dist/src/types/index.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -14,15 +14,17 @@ npm run dev
|
|
|
14
14
|
## 接入示例
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
import { SmartFill } from '@kc-
|
|
18
|
-
import '@kc-
|
|
17
|
+
import { SmartFill } from '@kc-one/smart-fill-sdk'
|
|
18
|
+
import '@kc-one/smart-fill-sdk/style.css'
|
|
19
19
|
|
|
20
20
|
await SmartFill.setup({ apiKey: 'seKey_xxxxxxxxxxxxx' })
|
|
21
21
|
// 网关地址在 src/config/defaults.ts 的 DEFAULT_BASE_URL 中配置
|
|
22
22
|
|
|
23
23
|
const smartFill = SmartFill.create({
|
|
24
24
|
formCode: 'apply-form',
|
|
25
|
-
strictFormConfig: true
|
|
25
|
+
strictFormConfig: true,
|
|
26
|
+
routeContainerSelector: '.page-container',
|
|
27
|
+
// floatingContainer: '#smart-fill-host'
|
|
26
28
|
})
|
|
27
29
|
|
|
28
30
|
smartFill.registerFields([
|
|
@@ -44,6 +46,23 @@ smartFill.registerFields([
|
|
|
44
46
|
smartFill.mountFloatingButton()
|
|
45
47
|
```
|
|
46
48
|
|
|
49
|
+
### 悬浮挂载策略
|
|
50
|
+
|
|
51
|
+
`mountFloatingButton()` 默认会自动识别当前 SPA 子路由页面容器；如果你的业务页面结构固定，推荐显式传入挂载策略，优先级如下：
|
|
52
|
+
|
|
53
|
+
1. `floatingContainer`: 直接指定悬浮面板挂载容器，支持 `HTMLElement` 或 CSS 选择器
|
|
54
|
+
2. `routeContainerSelector`: 指定当前子路由页面容器选择器
|
|
55
|
+
3. SDK 自动识别当前页面容器
|
|
56
|
+
4. 回退到 `document.body`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
const smartFill = SmartFill.create({
|
|
60
|
+
formCode: 'apply-form',
|
|
61
|
+
floatingContainer: '#smart-fill-host'
|
|
62
|
+
// 或 routeContainerSelector: '.app-main > .page-container'
|
|
63
|
+
})
|
|
64
|
+
```
|
|
65
|
+
|
|
47
66
|
## 核心流程
|
|
48
67
|
|
|
49
68
|
```text
|
|
@@ -181,10 +200,10 @@ smart-fill-sdk/
|
|
|
181
200
|
|
|
182
201
|
## 发布到 npm 公共仓库
|
|
183
202
|
|
|
184
|
-
包归属 [@kc-
|
|
203
|
+
包归属 [@kc-one](https://www.npmjs.com/settings/kc-one/packages) 组织，包名为 `@kc-one/smart-fill-sdk`。
|
|
185
204
|
|
|
186
205
|
```bash
|
|
187
|
-
npm login # 使用已加入 kc-
|
|
206
|
+
npm login # 使用已加入 kc-one 组织且开启 2FA 的账号
|
|
188
207
|
npm run build
|
|
189
208
|
npm publish --access public # publishConfig 已配置 public + registry.npmjs.org
|
|
190
209
|
```
|