Skip to content

Commit

Permalink
Merge pull request #23 from ivy-design/dev
Browse files Browse the repository at this point in the history
发布 v1.7.0 版本
  • Loading branch information
GuoJikun authored Feb 5, 2024
2 parents 4131070 + b0415c1 commit ed9406e
Show file tree
Hide file tree
Showing 59 changed files with 2,034 additions and 1,068 deletions.
54 changes: 54 additions & 0 deletions .gitee/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Bug 反馈
description: 当你在代码中发现了一个 Bug,导致应用崩溃或抛出异常,或者有一个组件存在问题,或者某些地方看起来不对劲。
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢对项目的支持与关注。在提出问题之前,请确保你已查看相关开发或使用文档:
- https://...
- type: checkboxes
attributes:
label: 这个问题是否已经存在?
options:
- label: 我已经搜索过现有的问题 (https://gitee.com/ivy-design/ivy-design-ce/issues)
required: true
- type: textarea
attributes:
label: 如何复现
description: 请详细告诉我们如何复现你遇到的问题,如涉及代码,可提供一个最小代码示例,并使用反引号```附上它
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
attributes:
label: 预期结果
description: 请告诉我们你预期会发生什么。
validations:
required: true
- type: textarea
attributes:
label: 实际结果
description: 请告诉我们实际发生了什么。
validations:
required: true
- type: textarea
attributes:
label: 截图或视频
description: 如果可以的话,上传任何关于 bug 的截图。
value: |
[在这里上传图片]
- type: dropdown
id: version
attributes:
label: 版本
description: 你当前正在使用我们软件的哪个版本/分支?
options:
- 1.0.2 (默认)
- 1.0.3 (最新)
validations:
required: true
43 changes: 43 additions & 0 deletions .gitee/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 功能建议
description: 对本项目提出一个功能建议
title: "[功能建议]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
感谢提出功能建议,我们将仔细考虑!
- type: textarea
id: related-problem
attributes:
label: 你的功能建议是否和某个问题相关?
description: 清晰并简洁地描述问题是什么,例如,当我...时,我总是感到困扰。
validations:
required: false
- type: textarea
id: desired-solution
attributes:
label: 你希望看到什么解决方案?
description: 清晰并简洁地描述你希望发生的事情。
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: 你考虑过哪些替代方案?
description: 清晰并简洁地描述你考虑过的任何替代解决方案或功能。
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 你有其他上下文或截图吗?
description: 在此处添加有关功能请求的任何其他上下文或截图。
validations:
required: false
- type: checkboxes
attributes:
label: 意向参与贡献
options:
- label: 我有意向参与具体功能的开发实现并将代码贡献回到上游社区
required: false
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: pnpm i --no-frozen-lockfile && pnpm run build-only # or pnpm install / yarn install / bun install
run: pnpm i --no-frozen-lockfile && pnpm run build # or pnpm install / yarn install / bun install
- name: Build with VitePress
run: |
pnpm docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
with:
version: 8
- run: pnpm i
- run: pnpm run build-only
- run: pnpm run build

publish-npm:
needs: build
Expand Down
7 changes: 6 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
"script",
"style",
"div",
"Badge",
"p",
"hr",
"ClientOnly",
"ivy-button",
"br",
Expand Down Expand Up @@ -66,7 +68,10 @@
"ivy-timeline-item",
"ivy-steps",
"ivy-step",
"ivy-tip"
"ivy-tip",
"ivy-tour-step",
"ivy-tour",
"ivy-card"
]
}
}
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,14 @@ pnpm test:unit
| split | 分割面板 |
| notification | 通知框 |
| pagination | 分页器 |
| tabs | 标签页 |
| message | 消息提醒 |
| tour | 漫游式引导 |

## 代办

| 组件名称 | 组件描述 |
| :--------- | :--------- |
| tabs | 标签页 |
| message | 消息提醒 |
| table | 表格 |
| datePicker | 日期选择器 |
| timePicker | 时间选择器 |
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
"build:comp": "pnpm --filter @ivy-design/ce run build",
"preview:comp": "pnpm --filter @ivy-design/ce run preview",
"test:unit": "pnpm --filter @ivy-design/ce run test:unit",
"build-only": "pnpm --filter @ivy-design/ce run build-only",
"type-check": "pnpm --filter @ivy-design/ce run type-check",
"lint": "pnpm --filter @ivy-design/ce run lint",
"format": "pnpm --filter @ivy-design/ce run format",
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
"vue": "^3.3.8"
},
"devDependencies": {
"vitepress": "1.0.0-rc.40"
"vitepress": "1.0.0-rc.41"
}
}
16 changes: 10 additions & 6 deletions packages/docs/src/.vitepress/config/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ const basic = [
const components = [
{
text: "基础/布局",
collapsible: true,
collapsed: false,
items: basic,
},
{
text: "表单",
collapsible: true,
collapsed: false,
items: [
{
text: "Checkbox 多选框",
Expand Down Expand Up @@ -118,7 +118,7 @@ const components = [
},
{
text: "数据展示",
collapsible: true,
collapsed: false,
items: [
{
text: "Avatar 头像",
Expand Down Expand Up @@ -172,6 +172,10 @@ const components = [
text: "Tag 标签",
link: "/components/tag",
},
{
text: "Tour 漫游式引导",
link: "/components/tour",
},
{
text: "Timeline 时间线",
link: "/components/timeline",
Expand All @@ -184,7 +188,7 @@ const components = [
},
{
text: "通知/反馈",
collapsible: true,
collapsed: false,
items: [
{
text: "Dialog 对话框",
Expand Down Expand Up @@ -226,7 +230,7 @@ const components = [
},
{
text: "导航",
collapsible: true,
collapsed: false,
items: [
{
text: "Affix 固钉",
Expand All @@ -252,7 +256,7 @@ const components = [
},
{
text: "其它",
collapsible: true,
collapsed: false,
items: [
{
text: "Clipboard 复制到剪切板",
Expand Down
10 changes: 2 additions & 8 deletions packages/docs/src/.vitepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
// https://vitepress.dev/guide/custom-theme
import { h } from "vue";
import Theme from "vitepress/theme";
import DefaultTheme from "vitepress/theme";
import "./style.css";
import { registerComponents } from "@ivy-design/ce";
import "@ivy-design/ce/dist/style.css";

export default {
...Theme,
Layout: () => {
return h(Theme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
});
},
extends: DefaultTheme,
enhanceApp(ctx) {
// ...
if (!import.meta.env.SSR) {
Expand Down
22 changes: 22 additions & 0 deletions packages/docs/src/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# 更新日志

## v1.7.0 版本

Feats:

- 增加 `tabs` 组件和对应文档
- 增加 `tour` 组件和对应文档
- 使用 floating-ui 重构浮层,涉及组件 `tooltip``tour``contextmenu`
- 增加 `Circle` 组件和文档

Build:

- 运行在开发环境时不再生成 types 类型文件

CI:

- 增加 issue 提 bug 时模板
- 增加自动发布到 npm

Test:

- 增加 hooks 中的 useIndex 单元测试

## v1.6.0 版本

Feats:
Expand Down
37 changes: 19 additions & 18 deletions packages/docs/src/components/card.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@

```html
<ivy-card style="width: 300px;">
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
</ivy-card>
```

Expand Down Expand Up @@ -47,27 +47,28 @@

```html
<ivy-card style="width: 300px;" shadow="always">
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
</ivy-card>
<ivy-card style="width: 300px;" shadow="hover">
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<p slot="header" style="margin: 0;">卡片头部</p>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
<div>卡片</div>
</ivy-card>
```

## API

### Props

| 属性 | 描述 | 类型 | 可选值 | 默认值 |
|---------|------------|---------|----------------|-----|
| header | 标题 | string | - | - |
| shadow | 卡片阴影-默认不显示 | string | `always/hover` | - |
| 属性 | 描述 | 类型 | 可选值 | 默认值 |
| ------ | ------------------- | ------ | -------------- | ------ |
| header | 标题 | string | - | - |
| shadow | 卡片阴影-默认不显示 | string | `always/hover` | - |
Loading

0 comments on commit ed9406e

Please sign in to comment.