Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support vue class component and metadata #2238

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/vue/.dumi/global.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import '@abraham/reflection'
6 changes: 6 additions & 0 deletions examples/vue/.dumi/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "../tsconfig.json",
"include": [
"**/*"
]
}
2 changes: 1 addition & 1 deletion examples/vue/.dumirc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ export default {
resolve: {
entryFile: './src/index.ts',
},
html2sketch: {},
presets: [require.resolve('@dumijs/preset-vue')],
vue: {
supportTsMetadata: true,
tsconfigPath: path.resolve(__dirname, './tsconfig.vue.json'),
checkerOptions: {
externalSymbolLinkMappings: {
Expand Down
36 changes: 33 additions & 3 deletions examples/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,58 @@
"directory": "examples/vue"
},
"license": "MIT",
"sideEffects": [
"**/*.css",
"**/*.less"
],
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": {
"types": "./dist/index.d.ts",
"default": "./dist/index.mjs"
}
},
"./dist/*": "./dist/*"
},
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"files": [
"dist",
"README.MD",
"CHANGELOG.md"
],
"scripts": {
"build": "node ../../bin/dumi.js build",
"build:lib": "vite build",
"dev": "node ../../bin/dumi.js dev",
"preview": "node ../../bin/dumi.js preview",
"setup": "node ../../bin/dumi.js setup",
"start": "npm run dev"
},
"dependencies": {
"@abraham/reflection": "^0.12.0",
"dayjs": "^1.11.10",
"element-plus": "^2.3.14",
"injection-js": "^2.4.0",
"pinia": "^2.1.7",
"react": "^18.2.0",
"vue": "3.4.28"
"vue": "3.4.28",
"vue3-oop": "^1.0.16"
},
"devDependencies": {
"@dumijs/preset-vue": "workspace:*",
"@typescript-eslint/parser": "^6.7.2",
"@vitejs/plugin-vue": "^5.2.1",
"@vue3-oop/plugin-vue-jsx": "^1.4.6",
"eslint-plugin-vue": "^9.17.0",
"typescript": "~4.7.4",
"typescript": "^5.6.3",
"unplugin-auto-import": "^0.16.6",
"unplugin-element-plus": "^0.8.0",
"unplugin-vue-components": "^0.25.2"
"unplugin-vue-components": "^0.25.2",
"vite": "^6.0.3",
"vite-plugin-dts": "^4.3.0",
"vite-plugin-no-bundle": "^4.0.0"
},
"authors": []
}
6 changes: 6 additions & 0 deletions examples/vue/shims-vue.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* eslint-disable */
declare module '*.vue' {
import type { DefineComponent } from 'vue';
const component: DefineComponent<{}, {}, any>;
export default component;
}
4 changes: 2 additions & 2 deletions examples/vue/src/Button/demos/Demo.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { Button } from '@examples/vue';
import { defineComponent, ref } from 'vue';
import { defineComponent, ref, type Ref } from 'vue';
import './demo.less';

export default defineComponent({
setup() {
const count = ref(0);
const count: Ref<number> = ref(0);
const handleClick = (e: Event) => {
count.value++;
};
Expand Down
10 changes: 8 additions & 2 deletions examples/vue/src/Button/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
import { defineComponent, PropType, shallowRef, SlotsType } from 'vue';
import {
defineComponent,
renderSlot,
shallowRef,
type PropType,
type SlotsType,
} from 'vue';
import './button.less';

export const buttonProps = {
Expand Down Expand Up @@ -83,7 +89,7 @@ const Button = defineComponent({
const { icon } = props;
return (
<button {...buttonProps} ref={buttonNodeRef}>
{slots.icon ? <slot name="icon"></slot> : icon} {slots.default?.()}
{renderSlot(slots, 'icon', {}, () => [icon])} {slots.default?.()}
</button>
);
};
Expand Down
47 changes: 47 additions & 0 deletions examples/vue/src/ClassComp/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
order: 10
---

# Class 组件支持

## 基础例子

```tsx
/**
* title: 代码示例
*/
import { ClassCount } from '@examples/vue';
import { defineComponent } from 'vue';
import { Mut, VueComponent } from 'vue3-oop';

class AAA extends VueComponent {
@Mut() count = 1001;
render() {
return (
<div onClick={() => this.count++}>class component: {this.count}</div>
);
}
}

export default defineComponent(() => () => (
<div>
<ClassCount initValue={10}></ClassCount>
</div>
));
```

## 属性

<API id="ClassCount" type="props"></API>

## 事件

<API id="ClassCount" type="events"></API>

## 方法

<API id="ClassCount" type="imperative"></API>

## slots

<API id="ClassCount" type="slots"></API>
58 changes: 58 additions & 0 deletions examples/vue/src/ClassComp/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import type { VNodeChild } from 'vue';
import { Mut, VueComponent, type ComponentProps } from 'vue3-oop';

export interface ClassCountProps {
/**
* @type T
* @description 数据源
*/
data?: Array<number>;
/**
* 默认数量
*/
initValue?: number;

/**
* @description 点击事件
*/
onClick?: () => Promise<string>;

slots: {
icon: ({ name }: { name: number[] }) => VNodeChild;
};
}

export class ClassCount<T> extends VueComponent<ClassCountProps> {
static defaultProps: ComponentProps<ClassCountProps> = [
'initValue',
'onClick',
'data',
];

@Mut() count = this.props.initValue;
/**
* foo方法
* @public
*/
foo(name: string) {}

render() {
return (
<div style={{ accentColor: 'green' }}>
<h2>我是类组件</h2>
<button style={{ marginBottom: '20px' }} onClick={() => this.count++}>
增加
</button>
<div
style={
'display:grid;place-items: center;height: 200px; background-color:yellow;'
}
>
<div style="background-color:red;color: #fff;padding: 10px;">
居中: {this.count}
</div>
</div>
</div>
);
}
}
2 changes: 1 addition & 1 deletion examples/vue/src/List.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {
SetupContext,
type SetupContext,
defineComponent,
onMounted,
ref,
Expand Down
35 changes: 35 additions & 0 deletions examples/vue/src/SimpleComp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: 简单组件
order: 11
---

# 简单组件

## 示例

### 基础使用

```tsx
import { SimpleComp } from '@examples/vue';
import { defineComponent } from 'vue3-oop';

export default defineComponent(() => {
return () => <SimpleComp data={11111}></SimpleComp>;
});
```

## 属性

<API id="SimpleComp" type="props"></API>

## 插槽

<API id="SimpleComp" type="slots"></API>

## 事件

<API id="SimpleComp" type="events"></API>

## 方法

<API id="SimpleComp" type="imperative"></API>
43 changes: 43 additions & 0 deletions examples/vue/src/SimpleComp/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import type { VNodeChild } from 'vue';
import { defineComponent } from 'vue3-oop';

export interface SimpleCompProps {
/**
* @description 数据源
*/
data?: number;
/**
* @description 打开事件
*/
onOpen?: () => void;

/**
* @description foo插槽
*/
renderFoo?: (name: string) => VNodeChild;
}

export interface SimpleCompExpose {
/**
* @description 聚焦芳芳
* @public
* @param name 姓名
*/
focus: (name: string) => void;
}

export interface SimpleCompSlots {
/**
* bar插槽
* @param name 1111
*/
bar: (name: string) => VNodeChild;
}

export const SimpleComp = defineComponent<
SimpleCompProps,
SimpleCompSlots,
SimpleCompExpose
>((props) => {
return () => <div>{props.data}</div>;
});
2 changes: 1 addition & 1 deletion examples/vue/src/functional.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FunctionalComponent as FC } from 'vue';
import { type FunctionalComponent as FC } from 'vue';
export interface ArticleProps {
/**
* 文章标题
Expand Down
2 changes: 2 additions & 0 deletions examples/vue/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import { h } from 'vue';

export { default as Button } from './Button';
export * from './ClassComp';
export { default as Foo } from './Foo';
export * from './List';
export * from './SimpleComp';
export { default as Article } from './functional';
export { default as Badge } from './my-badge.vue';

Expand Down
3 changes: 3 additions & 0 deletions examples/vue/src/my-badge.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.abc {
color: red;
}
3 changes: 2 additions & 1 deletion examples/vue/src/my-badge.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
</span>
</template>
<script setup lang="ts">
import { VNodeChild } from 'vue';
import './my-badge.css'
import { type VNodeChild } from 'vue';
defineProps<{
icon?: string;
}>();
Expand Down
17 changes: 16 additions & 1 deletion examples/vue/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"module": "ESNext",
"moduleResolution": "Bundler",
"target": "ES2020",
"baseUrl": "./",
"paths": {
"@examples/vue": ["./src"]
},
"allowJs": true,
"types": ["vue/jsx"],
"jsx": "preserve",
"jsxImportSource": "vue",
"isolatedModules": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"useDefineForClassFields": false,
"verbatimModuleSyntax": true,
"strictNullChecks": false
},
"include": [".dumirc.ts", "src/**/*", "docs/**/*"]
"include": [
".dumirc.ts",
"shims-vue.d.ts",
"vite.config.mts",
"src/**/*",
"docs/**/*"
]
}
Loading