diff --git a/.changeset/brown-bags-compete.md b/.changeset/brown-bags-compete.md deleted file mode 100644 index 05b0c313..00000000 --- a/.changeset/brown-bags-compete.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@watermark-design/vue': major ---- - -first major version diff --git a/.changeset/gentle-clouds-reply.md b/.changeset/gentle-clouds-reply.md deleted file mode 100644 index fcc15795..00000000 --- a/.changeset/gentle-clouds-reply.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@watermark-design/react': major ---- - -first major version diff --git a/.changeset/happy-bugs-look.md b/.changeset/happy-bugs-look.md deleted file mode 100644 index a6f4802a..00000000 --- a/.changeset/happy-bugs-look.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@watermark-design/core': major ---- - -first major version diff --git a/.changeset/two-geese-double.md b/.changeset/two-geese-double.md deleted file mode 100644 index 57559dbb..00000000 --- a/.changeset/two-geese-double.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@watermark-design/dom': major ---- - -first major version diff --git a/.changeset/unlucky-coins-smile.md b/.changeset/unlucky-coins-smile.md deleted file mode 100644 index 70e90fa5..00000000 --- a/.changeset/unlucky-coins-smile.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@watermark-design/shared': major ---- - -first major version diff --git a/LICENSE b/LICENSE index 1ea27417..1dfda718 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Company UI +Copyright (c) 2023 Watermark Design Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c7d6a84c..46b4bbb7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- company ui + watermark design

@@ -21,59 +21,38 @@ Works with both Vue 2 , Vue 3 And React. ### Vue -npm package -npm bundle size +npm package npm bundle size ```ts -import '@watermark-design/style'; import WatermarkDesign from '@watermark-design/vue'; app.use(WatermarkDesign); ``` ```vue - + +

+ ``` -[//]: # (### React) +### React -[//]: # () -[//]: # (npm package) +npm package npm bundle size -[//]: # (npm bundle size) - -[//]: # () -[//]: # (```ts) - -[//]: # (import '@watermark-design/style';) - -[//]: # (import { AutoComplete } from '@watermark-design/react';) - -[//]: # (```) - -[//]: # () -[//]: # (```jsx) - -[//]: # () +```ts +import { Watermark } from '@watermark-design/react'; +``` -[//]: # (```) +```jsx + +
+ +``` ### Dom -npm package -npm bundle size +npm package npm bundle size ```ts -import '@watermark-design/style'; import { Watermark } from '@watermark-design/dom'; const watermark = new Watermark({ @@ -81,6 +60,7 @@ const watermark = new Watermark({ width: 200, height: 200, }); +watermark.create(); ``` ## Documentation diff --git a/README_zh.md b/README_zh.md index df0d9a4c..c2f9ae56 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,6 +1,6 @@

- company ui + watermark design

@@ -17,58 +17,46 @@ ### Vue +npm package npm bundle size + ```ts -import '@watermark-design/style'; import WatermarkDesign from '@watermark-design/vue'; app.use(WatermarkDesign); ``` ```vue - + +

+ ``` -[//]: # (### React) - -[//]: # () -[//]: # (```ts) - -[//]: # (import '@watermark-design/style';) - -[//]: # (import { Watermark } from '@watermark-design/react';) - -[//]: # (```) - -[//]: # () -[//]: # (```jsx) - -[//]: # (npm package npm bundle size -[//]: # ( width={200}) - -[//]: # ( height={200}) - -[//]: # (>) - -[//]: # () +```ts +import { Watermark } from '@watermark-design/react'; +``` -[//]: # (```) +```jsx + +
+ +``` ### Dom +npm package npm bundle size + ```ts -import '@watermark-design/style'; import { Watermark } from '@watermark-design/dom'; const watermark = new Watermark({ content: 'hello my watermark', width: 200, height: 200, - onSuccess: () => { - // success callback - } }); +watermark.create(); ``` ## 文档 diff --git a/docs/components/dom/watermark.md b/docs/components/dom/watermark.md index a270cdc3..d39f3b76 100644 --- a/docs/components/dom/watermark.md +++ b/docs/components/dom/watermark.md @@ -19,94 +19,57 @@ onMounted(() => { ```ts import { Watermark } from '@watermark-design/dom'; -new Watermark({ +const watermark = new Watermark({ content: 'hello my text watermark', width: 200, height: 200, }); +watermark.create(); ``` -[//]: # () -[//]: # (## API) - -[//]: # () -[//]: # (### Attributes) - -[//]: # () -[//]: # (| Name | Description | Type | Default |) - -[//]: # (| --- | --- | --- | --- |) - -[//]: # (| target | id of the html element tag | `string` | - |) - -[//]: # (| api | query data source | `string` | clearbit |) - -[//]: # (| queryDelay | query data delay | `number` | 500 |) - -[//]: # (| placeholder | input placeholder content | `string` | 请输入企业名称或统一社会信用代码 |) - -[//]: # (| clearable | show clear button | `boolean` | true |) - -[//]: # (| backFill | If backFill selected item the input when using keyboard | `boolean` | true |) - -[//]: # (| popupAppendToBody | whether to append Dialog itself to body | `boolean` | true |) - -[//]: # (| autoFocus | auto focus | `boolean` | true |) - -[//]: # (| showSubmitButton | show submit button | `boolean` | true |) - -[//]: # (| submitButtonLabel | submit button label | `string` | Submit |) - -[//]: # (| offsetTop | pixels to offset from input bottom | `number` | 5 |) - -[//]: # (| autoFlip | auto flip | `boolean` | false |) - -[//]: # (| avatarUrl | avatar url | `string` | - |) - -[//]: # (| clearIcon | clear icon | `string` | |) - -[//]: # (| history | history options | `HistoryOptions` | [HistoryOptions](#historyoptions) |) - -[//]: # () -[//]: # (### HistoryOptions) - -[//]: # () -[//]: # (| Name | Description | Type | Default |) - -[//]: # (| --- | --- | --- | --- |) - -[//]: # (| enabled | history enabled | `boolean` | true |) - -[//]: # (| type | history save mode | `string` | localStorage |) - -[//]: # (| key | history save key | `string` | company-history |) - -[//]: # (| showClear | show clear history link | `boolean` | true |) - -[//]: # (| itemIcon | history item icon | `string` | |) - -[//]: # (| clearIcon | clear history link icon | `string` | |) - -[//]: # () -[//]: # (### Events) - -[//]: # () -[//]: # (| Name | Description | Type |) - -[//]: # (| --- | --- | --- |) - -[//]: # (| onFetch | triggers when query data | `Function` |) - -[//]: # (| onAbortFetch | triggers when abort query data | `Function` |) - -[//]: # (| onSelect | triggers when a suggestion is clicked | `Function` |) - -[//]: # (| onClear | triggers when the input is cleared by clicking the clear button | `Function` |) - -[//]: # (| onFocus | triggers when the input focuses | `Function` |) - -[//]: # (| onBlur | triggers when the input blurs | `Function` |) - -[//]: # (| submitCallback | triggers when the button submit | `Function` |) - -[//]: # (| onDropdownVisibleChange | triggers when the dropdown appears/disappears | `Function` |) +[//]: # +[//]: # '## API' +[//]: # +[//]: # '### Attributes' +[//]: # +[//]: # '| Name | Description | Type | Default |' +[//]: # '| --- | --- | --- | --- |' +[//]: # '| target | id of the html element tag | `string` | - |' +[//]: # '| api | query data source | `string` | clearbit |' +[//]: # '| queryDelay | query data delay | `number` | 500 |' +[//]: # '| placeholder | input placeholder content | `string` | 请输入企业名称或统一社会信用代码 |' +[//]: # '| clearable | show clear button | `boolean` | true |' +[//]: # '| backFill | If backFill selected item the input when using keyboard | `boolean` | true |' +[//]: # '| popupAppendToBody | whether to append Dialog itself to body | `boolean` | true |' +[//]: # '| autoFocus | auto focus | `boolean` | true |' +[//]: # '| showSubmitButton | show submit button | `boolean` | true |' +[//]: # '| submitButtonLabel | submit button label | `string` | Submit |' +[//]: # '| offsetTop | pixels to offset from input bottom | `number` | 5 |' +[//]: # '| autoFlip | auto flip | `boolean` | false |' +[//]: # '| avatarUrl | avatar url | `string` | - |' +[//]: # '| clearIcon | clear icon | `string` | |' +[//]: # '| history | history options | `HistoryOptions` | [HistoryOptions](#historyoptions) |' +[//]: # +[//]: # '### HistoryOptions' +[//]: # +[//]: # '| Name | Description | Type | Default |' +[//]: # '| --- | --- | --- | --- |' +[//]: # '| enabled | history enabled | `boolean` | true |' +[//]: # '| type | history save mode | `string` | localStorage |' +[//]: # '| key | history save key | `string` | company-history |' +[//]: # '| showClear | show clear history link | `boolean` | true |' +[//]: # '| itemIcon | history item icon | `string` | |' +[//]: # '| clearIcon | clear history link icon | `string` | |' +[//]: # +[//]: # '### Events' +[//]: # +[//]: # '| Name | Description | Type |' +[//]: # '| --- | --- | --- |' +[//]: # '| onFetch | triggers when query data | `Function` |' +[//]: # '| onAbortFetch | triggers when abort query data | `Function` |' +[//]: # '| onSelect | triggers when a suggestion is clicked | `Function` |' +[//]: # '| onClear | triggers when the input is cleared by clicking the clear button | `Function` |' +[//]: # '| onFocus | triggers when the input focuses | `Function` |' +[//]: # '| onBlur | triggers when the input blurs | `Function` |' +[//]: # '| submitCallback | triggers when the button submit | `Function` |' +[//]: # '| onDropdownVisibleChange | triggers when the dropdown appears/disappears | `Function` |' diff --git a/docs/zh/components/dom/watermark.md b/docs/zh/components/dom/watermark.md index 513dbd20..71bc6abe 100644 --- a/docs/zh/components/dom/watermark.md +++ b/docs/zh/components/dom/watermark.md @@ -19,94 +19,57 @@ onMounted(() => { ```ts import { Watermark } from '@watermark-design/dom'; -new Watermark({ +const watermark = new Watermark({ content: 'hello my text watermark', width: 200, height: 200, }); +watermark.create(); ``` -[//]: # () -[//]: # (## API) - -[//]: # () -[//]: # (### Attributes) - -[//]: # () -[//]: # (| Name | Description | Type | Default |) - -[//]: # (| --- | --- | --- | --- |) - -[//]: # (| target | HTML元素标签的id | `string` | - |) - -[//]: # (| api | 查询数据源 | `string` | clearbit |) - -[//]: # (| queryDelay | 查询数据延迟 | `number` | 500 |) - -[//]: # (| placeholder | 输入占位符内容 | `string` | 请输入企业名称或统一社会信用代码 |) - -[//]: # (| clearable | 显示清除按钮 | `boolean` | true |) - -[//]: # (| backFill | 使用键盘选择选项的时候把选中项回填到输入框中 | `boolean` | true |) - -[//]: # (| popupAppendToBody | 是否插入至 body 元素上 | `boolean` | true |) - -[//]: # (| autoFocus | 自动获取焦点 | `boolean` | true |) - -[//]: # (| showSubmitButton | 显示提交按钮 | `boolean` | true |) - -[//]: # (| submitButtonLabel | 提交按钮文字 | `string` | Submit |) - -[//]: # (| offsetTop | 距离文本框底部的偏移值 | `number` | 5 |) - -[//]: # (| autoFlip | 文本框是否自动翻转 | `boolean` | false |) - -[//]: # (| avatarUrl | 头像链接 | `string` | - |) - -[//]: # (| clearIcon | 清除按钮图标 | `string` | |) - -[//]: # (| history | 历史记录配置 | `HistoryOptions` | [HistoryOptions](#historyoptions) |) - -[//]: # () -[//]: # (### HistoryOptions) - -[//]: # () -[//]: # (| Name | Description | Type | Default |) - -[//]: # (| --- | --- | --- | --- |) - -[//]: # (| enabled | 打开保存历史记录 | `boolean` | true |) - -[//]: # (| type | 保存历史记录模式 | `string` | localStorage |) - -[//]: # (| key | 保存历史记录键 | `string` | company-history |) - -[//]: # (| showClear | 显示历史记录清除按钮 | `boolean` | true |) - -[//]: # (| itemIcon | 历史记录图标 | `string` | |) - -[//]: # (| clearIcon | 清除历史记录按钮图标 | `string` | |) - -[//]: # () -[//]: # (### Events) - -[//]: # () -[//]: # (| Name | Description | Type |) - -[//]: # (| ----------------------- | -------------------------- | ---------- |) - -[//]: # (| onFetch | 查询数据时触发 | `Function` |) - -[//]: # (| onAbortFetch | 当中止查询数据时触发 | `Function` |) - -[//]: # (| onSelect | 当单击建议时触发 | `Function` |) - -[//]: # (| onClear | 当单击文本框清除按钮时触发 | `Function` |) - -[//]: # (| onFocus | 当输入聚焦时触发 | `Function` |) - -[//]: # (| onBlur | 当输入取消聚焦时触发 | `Function` |) - -[//]: # (| submitCallback | 按钮提交时触发 | `Function` |) - -[//]: # (| onDropdownVisibleChange | 当下拉菜单出现/消失时触发 | `Function` |) +[//]: # +[//]: # '## API' +[//]: # +[//]: # '### Attributes' +[//]: # +[//]: # '| Name | Description | Type | Default |' +[//]: # '| --- | --- | --- | --- |' +[//]: # '| target | HTML元素标签的id | `string` | - |' +[//]: # '| api | 查询数据源 | `string` | clearbit |' +[//]: # '| queryDelay | 查询数据延迟 | `number` | 500 |' +[//]: # '| placeholder | 输入占位符内容 | `string` | 请输入企业名称或统一社会信用代码 |' +[//]: # '| clearable | 显示清除按钮 | `boolean` | true |' +[//]: # '| backFill | 使用键盘选择选项的时候把选中项回填到输入框中 | `boolean` | true |' +[//]: # '| popupAppendToBody | 是否插入至 body 元素上 | `boolean` | true |' +[//]: # '| autoFocus | 自动获取焦点 | `boolean` | true |' +[//]: # '| showSubmitButton | 显示提交按钮 | `boolean` | true |' +[//]: # '| submitButtonLabel | 提交按钮文字 | `string` | Submit |' +[//]: # '| offsetTop | 距离文本框底部的偏移值 | `number` | 5 |' +[//]: # '| autoFlip | 文本框是否自动翻转 | `boolean` | false |' +[//]: # '| avatarUrl | 头像链接 | `string` | - |' +[//]: # '| clearIcon | 清除按钮图标 | `string` | |' +[//]: # '| history | 历史记录配置 | `HistoryOptions` | [HistoryOptions](#historyoptions) |' +[//]: # +[//]: # '### HistoryOptions' +[//]: # +[//]: # '| Name | Description | Type | Default |' +[//]: # '| --- | --- | --- | --- |' +[//]: # '| enabled | 打开保存历史记录 | `boolean` | true |' +[//]: # '| type | 保存历史记录模式 | `string` | localStorage |' +[//]: # '| key | 保存历史记录键 | `string` | company-history |' +[//]: # '| showClear | 显示历史记录清除按钮 | `boolean` | true |' +[//]: # '| itemIcon | 历史记录图标 | `string` | |' +[//]: # '| clearIcon | 清除历史记录按钮图标 | `string` | |' +[//]: # +[//]: # '### Events' +[//]: # +[//]: # '| Name | Description | Type |' +[//]: # '| ----------------------- | -------------------------- | ---------- |' +[//]: # '| onFetch | 查询数据时触发 | `Function` |' +[//]: # '| onAbortFetch | 当中止查询数据时触发 | `Function` |' +[//]: # '| onSelect | 当单击建议时触发 | `Function` |' +[//]: # '| onClear | 当单击文本框清除按钮时触发 | `Function` |' +[//]: # '| onFocus | 当输入聚焦时触发 | `Function` |' +[//]: # '| onBlur | 当输入取消聚焦时触发 | `Function` |' +[//]: # '| submitCallback | 按钮提交时触发 | `Function` |' +[//]: # '| onDropdownVisibleChange | 当下拉菜单出现/消失时触发 | `Function` |' diff --git a/docs/zh/index.md b/docs/zh/index.md index 7137592e..040622ef 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -10,7 +10,7 @@ hero: tagline: 简易、强大、高性能。 image: src: /full-logo.png - alt: company-ui + alt: watermark design actions: - theme: brand text: 开始 👆 diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index e69de29b..f70f1001 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -0,0 +1,12 @@ +# @watermark-design/core + +## 1.0.0 + +### Major Changes + +- [`b3a40b9`](https://github.com/watermark-design/watermark/commit/b3a40b9d7c929896053b87e1d061b826993a8271) Thanks [@zhensherlock](https://github.com/zhensherlock)! - first major version + +### Patch Changes + +- Updated dependencies [[`76c7336`](https://github.com/watermark-design/watermark/commit/76c733646c98dc29cf5b540778c00ae413a457b5)]: + - @watermark-design/shared@1.0.0 diff --git a/packages/core/package.json b/packages/core/package.json index d43b7b82..9f1c9edc 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/core", - "version": "0.0.0", + "version": "1.0.0", "description": "watermark design core", "author": "zhensherlock", "homepage": "https://github.com/watermark-design/watermark/tree/master/packages/core#readme", diff --git a/packages/dom/CHANGELOG.md b/packages/dom/CHANGELOG.md index e69de29b..387b07ce 100644 --- a/packages/dom/CHANGELOG.md +++ b/packages/dom/CHANGELOG.md @@ -0,0 +1,13 @@ +# @watermark-design/dom + +## 1.0.0 + +### Major Changes + +- [`b5fc9cb`](https://github.com/watermark-design/watermark/commit/b5fc9cb7914fd4c4aabc3fe0b4c4688ddfd604ac) Thanks [@zhensherlock](https://github.com/zhensherlock)! - first major version + +### Patch Changes + +- Updated dependencies [[`b3a40b9`](https://github.com/watermark-design/watermark/commit/b3a40b9d7c929896053b87e1d061b826993a8271), [`76c7336`](https://github.com/watermark-design/watermark/commit/76c733646c98dc29cf5b540778c00ae413a457b5)]: + - @watermark-design/core@1.0.0 + - @watermark-design/shared@1.0.0 diff --git a/packages/dom/package.json b/packages/dom/package.json index a3565b5a..74d7c9ce 100644 --- a/packages/dom/package.json +++ b/packages/dom/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/dom", - "version": "0.0.0", + "version": "1.0.0", "description": "watermark design dom", "author": "zhensherlock", "homepage": "https://github.com/watermark-design/watermark/tree/master/packages/dom#readme", diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md index e69de29b..ab8a5741 100644 --- a/packages/react/CHANGELOG.md +++ b/packages/react/CHANGELOG.md @@ -0,0 +1,14 @@ +# @watermark-design/react + +## 1.0.0 + +### Major Changes + +- [`4b2fa42`](https://github.com/watermark-design/watermark/commit/4b2fa42bfe6d45c4316148935a0991d0b6427255) Thanks [@zhensherlock](https://github.com/zhensherlock)! - first major version + +### Patch Changes + +- Updated dependencies [[`b3a40b9`](https://github.com/watermark-design/watermark/commit/b3a40b9d7c929896053b87e1d061b826993a8271), [`76c7336`](https://github.com/watermark-design/watermark/commit/76c733646c98dc29cf5b540778c00ae413a457b5)]: + - @watermark-design/core@1.0.0 + - @watermark-design/shared@1.0.0 + - @watermark-design/style@1.0.0 diff --git a/packages/react/package.json b/packages/react/package.json index 1cf87622..9554f640 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/react", - "version": "0.0.0", + "version": "1.0.0", "description": "watermark design react", "author": "zhensherlock", "homepage": "https://github.com/watermark-design/watermark/tree/master/packages/react#readme", diff --git a/packages/shared/CHANGELOG.md b/packages/shared/CHANGELOG.md index e69de29b..d62d1ecb 100644 --- a/packages/shared/CHANGELOG.md +++ b/packages/shared/CHANGELOG.md @@ -0,0 +1,7 @@ +# @watermark-design/shared + +## 1.0.0 + +### Major Changes + +- [`76c7336`](https://github.com/watermark-design/watermark/commit/76c733646c98dc29cf5b540778c00ae413a457b5) Thanks [@zhensherlock](https://github.com/zhensherlock)! - first major version diff --git a/packages/shared/package.json b/packages/shared/package.json index b08bc211..952837b6 100644 --- a/packages/shared/package.json +++ b/packages/shared/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/shared", - "version": "0.0.0", + "version": "1.0.0", "description": "watermark-design shared", "author": "zhensherlock", "homepage": "https://github.com/watermark-design/watermark/tree/master/packages/shared#readme", diff --git a/packages/style/CHANGELOG.md b/packages/style/CHANGELOG.md index e69de29b..24a65f15 100644 --- a/packages/style/CHANGELOG.md +++ b/packages/style/CHANGELOG.md @@ -0,0 +1,3 @@ +# @watermark-design/style + +## 1.0.0 diff --git a/packages/style/package.json b/packages/style/package.json index 7212bbd4..710c0f49 100644 --- a/packages/style/package.json +++ b/packages/style/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/style", - "version": "0.0.0", + "version": "1.0.0", "private": true, "description": "watermark design style", "author": "zhensherlock", diff --git a/packages/vue/CHANGELOG.md b/packages/vue/CHANGELOG.md index e69de29b..1f65cdcf 100644 --- a/packages/vue/CHANGELOG.md +++ b/packages/vue/CHANGELOG.md @@ -0,0 +1,14 @@ +# @watermark-design/vue + +## 1.0.0 + +### Major Changes + +- [`2b67805`](https://github.com/watermark-design/watermark/commit/2b678055f4dcfcf8bec5b69d0fb19de91a68753f) Thanks [@zhensherlock](https://github.com/zhensherlock)! - first major version + +### Patch Changes + +- Updated dependencies [[`b3a40b9`](https://github.com/watermark-design/watermark/commit/b3a40b9d7c929896053b87e1d061b826993a8271), [`76c7336`](https://github.com/watermark-design/watermark/commit/76c733646c98dc29cf5b540778c00ae413a457b5)]: + - @watermark-design/core@1.0.0 + - @watermark-design/shared@1.0.0 + - @watermark-design/style@1.0.0 diff --git a/packages/vue/package.json b/packages/vue/package.json index 5b5a08d0..655acfd6 100644 --- a/packages/vue/package.json +++ b/packages/vue/package.json @@ -1,6 +1,6 @@ { "name": "@watermark-design/vue", - "version": "0.0.0", + "version": "1.0.0", "description": "watermark design vue", "author": "zhensherlock", "homepage": "https://github.com/watermark-design/watermark/tree/master/packages/vue#readme", diff --git a/playground-vue2.7/vue/app.vue b/playground-vue2.7/vue/app.vue index 6a01f232..10afcca9 100644 --- a/playground-vue2.7/vue/app.vue +++ b/playground-vue2.7/vue/app.vue @@ -1,9 +1,9 @@ @@ -12,7 +12,7 @@ name: 'App', data() { return { - text: 'ssssss' + text: 'ssssss', }; }, };