@xrubik/fabric-to-leafer-elements 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @rubik/fabric-to-leafer-elements
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+供 `@rubik/fabric-to-leafer` 产物使用的 Leafer 自定义元素：
+
+| 元素 | 基类 | tag |
+| --- | --- | --- |
+| `Button` | `Box` | `Button` |
+| `Bar` | `Box` | `Bar` |
+| `Circle` | `Path` | `Circle` |
+| `Lib` | `Group` | `Lib` |
+
+`Button` 的交互(悬停遮罩 / 按下下陷 / 禁用)全部在元素内部实现：
+按下 = 文字右下移 1px + 上左边框 `#5F5F5F`、下右边框 `#EFEFEF`(松开还原) + 隐藏悬停遮罩，
+与 Fabric `Button._render` 的倒角翻转一致；`updatePressState()` 是唯一的状态同步入口。
+
+导入本包即完成 `registerUI()` 注册，宿主直接使用 `leafer-ui`（peerDependency），不会打进产物。
+
+```js
+import { Button, Bar, Circle, Lib } from '@rubik/fabric-to-leafer-elements'
+
+const lib = new Lib({ libName: '图元/手动门', children: [] })
+
+const button = new Button({
+  text: '确定',
+  width: 120,
+  height: 40,
+  backgroundColor: '#1677ff'
+})
+```