修改插件的实现和文档

This commit is contained in:
编码猿
2025-09-19 13:01:26 +08:00
parent 79a0c9a451
commit b3718c4097
10 changed files with 130 additions and 120 deletions

101
README.md
View File

@@ -91,8 +91,9 @@ src/
```tsx ```tsx
// 首页 页面 // 首页 页面
import { Autobind, Component, Link, Mut, VueComponent } from 'vue3-oop' import { Component, Ref, Setup, Vue } from 'vue-facing-decorator'
import Header from '@/components/Header' import Header from '../components/Header'
import { RouteLocationNormalizedLoaded, Router, useRoute, useRouter } from "vue-router";
interface ListItemType { interface ListItemType {
id: number id: number
@@ -100,44 +101,52 @@ interface ListItemType {
} }
@Component() @Component()
export default class Home extends VueComponent { export default class Home extends Vue {
@Mut() counter: number = 1;
count: number = 1
@Mut() @Ref
text: string = "Home props 传给 Header 的字符串" readonly refH1!: HTMLDivElement
@Setup((props, ctx) => useRouter())
router!: Router
@Setup((props, ctx) => useRoute())
route!: RouteLocationNormalizedLoaded
@Mut()
newList: ListItemType[] = [ newList: ListItemType[] = [
{ id: 1, title: '新闻1' }, { id: 1, title: '新闻1' },
{ id: 2, title: '新闻2' }, { id: 2, title: '新闻2' },
{ id: 3, title: '新闻3' }, { id: 3, title: '新闻3' },
] ]
@Link() H1?: HTMLDivElement addCount() {
// console.log("ref dom: ", this.refH1)
@Autobind() // this.router.push({ name: 'about' })
async addCount() { // this.route.query
this.count++ this.counter++
this.text = "22222"
console.log(this.H1)
} }
testHtml() {
return <p>测试html jsx 函数</p>
}
render() { render() {
return ( return (
<div class="home" ref="H1"> <div class="home">
<h1>首页</h1> <h1 ref="refH1">首页</h1>
<p onClick={ this.addCount }>count响应式变量(点我):{ this.count }</p> <p onClick={ this.addCount }>counter 响应式变量(点我):{ this.counter }</p>
<Header <Header
v-slots={ { list={ this.newList }
text={ "测试" }>
{ {
default: () => <div class="default">父到子 default 插槽</div>, default: () => <div class="default">父到子 default 插槽</div>,
haveName: () => <div class="haveName">父到子 具名 插槽</div>, haveName: () => <div class="haveName">父到子 具名 插槽</div>,
item: (val) => <li key={ val.id }>{ val.title }</li> item: (val: ListItemType) => <li key={ val.id }>{ val.title }</li>
} } } }
list={ this.newList }
text={ this.text }>
</Header> </Header>
{ this.testHtml }
</div> </div>
) )
} }
@@ -146,53 +155,43 @@ export default class Home extends VueComponent {
```tsx ```tsx
// 头部组件 // 头部组件
import { Component, ComponentProps, Hook, useProps, VueComponent } from 'vue3-oop' import { Component, Prop, TSX, Vue } from 'vue-facing-decorator'
import { JSX } from "vue/jsx-runtime";
import { VNodeChild } from "vue"; interface Props {
text?: string
list?: ListItemType[]
}
interface ListItemType { interface ListItemType {
id: number id: number
title: string title: string
} }
interface HeaderProps {
text?: string;
list: ListItemType[]
slots: {
default: () => JSX.Element;
haveName: () => JSX.Element;
item: (val: ListItemType) => VNodeChild;
}
}
@Component() @Component()
export default class Header extends VueComponent<HeaderProps> { export default class Header extends TSX<Props>()(Vue) implements Props {
// required 的 true or false 需要和 类型中 text的? 对应 @Prop({ default: '默认数值' })
static defaultProps: ComponentProps<HeaderProps> = { text!: string;
text: { default: '默认数值', required: true },
list: { default: () => [] }
};
@Hook('Mounted') @Prop()
mounted() { list!: ListItemType[];
console.log("this: ", this);
console.log('Header 组件的 mounted 生命周期...') created() {
console.log("created: ", this)
} }
render() { render() {
const { text, list } = useProps<HeaderProps>();
return ( return (
<div class="header"> <div class="header">
头部组件 头部组件
<p>{ text }</p> <p>{ this.text }</p>
{ this.context.slots.default?.() } { this.$slots.default?.() }
{ this.context.slots.haveName?.() } { this.$slots.haveName?.() }
<ul> <ul>
{ {
list.map( this.list.map(
item => item =>
this.context.slots.item?.(item) this.$slots.item?.(item)
) )
} }
</ul> </ul>

View File

@@ -16,6 +16,7 @@
"dependencies": { "dependencies": {
"pinia": "^3.0.3", "pinia": "^3.0.3",
"vue": "^3.5.18", "vue": "^3.5.18",
"vue-facing-decorator": "^4.0.1",
"vue-router": "^4.0.6" "vue-router": "^4.0.6"
}, },
"devDependencies": { "devDependencies": {

View File

@@ -1,8 +1,8 @@
import { Component, VueComponent } from 'vue3-oop' import { Component, Vue } from 'vue-facing-decorator'
import { RouterLink, RouterView } from "vue-router"; import { RouterLink, RouterView } from "vue-router";
@Component() @Component()
export class App extends VueComponent { export default class App extends Vue {
render() { render() {
return ( return (
<> <>

View File

@@ -1,50 +1,40 @@
import { Component, ComponentProps, Hook, useProps, VueComponent } from 'vue3-oop' import { Component, Prop, TSX, Vue } from 'vue-facing-decorator'
import { JSX } from "vue/jsx-runtime";
import { VNodeChild } from "vue"; interface Props {
text?: string
list?: ListItemType[]
}
interface ListItemType { interface ListItemType {
id: number id: number
title: string title: string
} }
interface HeaderProps {
text?: string;
list: ListItemType[]
slots: {
default: () => JSX.Element;
haveName: () => JSX.Element;
item: (val: ListItemType) => VNodeChild;
}
}
@Component() @Component()
export default class Header extends VueComponent<HeaderProps> { export default class Header extends TSX<Props>()(Vue) implements Props {
// required 的 true or false 需要和 类型中 text的? 对应 @Prop({ default: '默认数值' })
static defaultProps: ComponentProps<HeaderProps> = { text!: string;
text: { default: '默认数值', required: true },
list: { default: () => [] }
};
@Hook('Mounted') @Prop()
mounted() { list!: ListItemType[];
console.log("this: ", this);
console.log('Header 组件的 mounted 生命周期...') created() {
console.log("created: ", this)
} }
render() { render() {
const { text, list } = useProps<HeaderProps>();
return ( return (
<div class="header"> <div class="header">
<p>{ text }</p> <p>{ this.text }</p>
{ this.context.slots.default?.() } { this.$slots.default?.() }
{ this.context.slots.haveName?.() } { this.$slots.haveName?.() }
<ul> <ul>
{ {
list.map( this.list.map(
item => item =>
this.context.slots.item?.(item) this.$slots.item?.(item)
) )
} }
</ul> </ul>
@@ -52,3 +42,4 @@ export default class Header extends VueComponent<HeaderProps> {
) )
} }
} }

View File

@@ -2,10 +2,9 @@
import '@abraham/reflection' import '@abraham/reflection'
import { createApp } from 'vue' import { createApp } from 'vue'
import { createPinia } from 'pinia' import { createPinia } from 'pinia'
import { App } from './App' import App from './App'
import router from './router' import router from './router'
class Main { class Main {
constructor() { constructor() {
createApp(App) createApp(App)

View File

@@ -1,7 +1,7 @@
import {Component, VueComponent} from 'vue3-oop' import { Component, Vue } from 'vue-facing-decorator'
@Component() @Component()
export default class About extends VueComponent { export default class About extends Vue {
render() { render() {
return ( return (
<div class="about"> <div class="about">

View File

@@ -1,5 +1,6 @@
import { Autobind, Component, Link, Mut, VueComponent } from 'vue3-oop' import { Component, Ref, Setup, Vue } from 'vue-facing-decorator'
import Header from '@/components/Header' import Header from '../components/Header'
import { RouteLocationNormalizedLoaded, Router, useRoute, useRouter } from "vue-router";
interface ListItemType { interface ListItemType {
id: number id: number
@@ -7,44 +8,52 @@ interface ListItemType {
} }
@Component() @Component()
export default class Home extends VueComponent { export default class Home extends Vue {
@Mut() counter: number = 1;
count: number = 1
@Mut() @Ref
text: string = "Home props 传给 Header 的字符串" readonly refH1!: HTMLDivElement
@Setup((props, ctx) => useRouter())
router!: Router
@Setup((props, ctx) => useRoute())
route!: RouteLocationNormalizedLoaded
@Mut()
newList: ListItemType[] = [ newList: ListItemType[] = [
{ id: 1, title: '新闻1' }, { id: 1, title: '新闻1' },
{ id: 2, title: '新闻2' }, { id: 2, title: '新闻2' },
{ id: 3, title: '新闻3' }, { id: 3, title: '新闻3' },
] ]
@Link() H1?: HTMLDivElement addCount() {
// console.log("ref dom: ", this.refH1)
@Autobind() // this.router.push({ name: 'about' })
async addCount() { // this.route.query
this.count++ this.counter++
this.text = "22222"
console.log(this.H1)
} }
testHtml() {
return <p>html jsx </p>
}
render() { render() {
return ( return (
<div class="home" ref="H1"> <div class="home">
<h1></h1> <h1 ref="refH1"></h1>
<p onClick={ this.addCount }>count响应式变{ this.count }</p> <p onClick={ this.addCount }>counter { this.counter }</p>
<Header <Header
v-slots={ { list={ this.newList }
text={ "测试" }>
{ {
default: () => <div class="default"> default </div>, default: () => <div class="default"> default </div>,
haveName: () => <div class="haveName"> </div>, haveName: () => <div class="haveName"> </div>,
item: (val) => <li key={ val.id }>{ val.title }</li> item: (val: ListItemType) => <li key={ val.id }>{ val.title }</li>
} } } }
list={ this.newList }
text={ this.text }>
</Header> </Header>
{ this.testHtml }
</div> </div>
) )
} }

View File

@@ -1,11 +1,24 @@
import { defineComponent } from 'vue' // import { defineComponent } from 'vue'
//
// export default defineComponent({
// setup() {
// return () => (
// <div class="404">
// <h1>404</h1>
// </div>
// )
// }
// })
export default defineComponent({ import { Component, Vue } from 'vue-facing-decorator'
setup() {
return () => ( @Component()
export default class About extends Vue {
render() {
return (
<div class="404"> <div class="404">
<h1>404</h1> <h1>404</h1>
</div> </div>
) )
} }
}) }

View File

@@ -3,9 +3,7 @@
"target": "ESNext", "target": "ESNext",
"module": "ESNext", "module": "ESNext",
"importHelpers": true, "importHelpers": true,
"isolatedModules": true,
"experimentalDecorators": true, "experimentalDecorators": true,
"emitDecoratorMetadata": true,
"useDefineForClassFields": false, "useDefineForClassFields": false,
"moduleResolution": "Bundler", "moduleResolution": "Bundler",
"strict": true, "strict": true,