{"id":28359938,"url":"https://github.com/pure-admin/pure-admin-descriptions","last_synced_at":"2025-07-02T10:32:45.589Z","repository":{"id":38743954,"uuid":"506473591","full_name":"pure-admin/pure-admin-descriptions","owner":"pure-admin","description":"使用tsx语法二次封装element-plus的Descriptions，提供灵活的配置项","archived":false,"fork":false,"pushed_at":"2024-03-12T17:48:54.000Z","size":1595,"stargazers_count":14,"open_issues_count":0,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-22T20:38:07.675Z","etag":null,"topics":["el-descriptions","element-plus","pure-admin-descriptions"],"latest_commit_sha":null,"homepage":"https://pure-admin.github.io/pure-admin-descriptions","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pure-admin.png","metadata":{"files":{"readme":"README.en-US.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-23T02:38:09.000Z","updated_at":"2025-02-25T06:25:37.000Z","dependencies_parsed_at":"2024-06-18T20:11:04.192Z","dependency_job_id":null,"html_url":"https://github.com/pure-admin/pure-admin-descriptions","commit_stats":null,"previous_names":["xiaoxian521/pure-admin-descriptions"],"tags_count":7,"template":true,"template_full_name":null,"purl":"pkg:github/pure-admin/pure-admin-descriptions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pure-admin%2Fpure-admin-descriptions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pure-admin%2Fpure-admin-descriptions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pure-admin%2Fpure-admin-descriptions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pure-admin%2Fpure-admin-descriptions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pure-admin","download_url":"https://codeload.github.com/pure-admin/pure-admin-descriptions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pure-admin%2Fpure-admin-descriptions/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262831932,"owners_count":23371590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["el-descriptions","element-plus","pure-admin-descriptions"],"created_at":"2025-05-28T10:10:40.260Z","updated_at":"2025-07-02T10:32:45.574Z","avatar_url":"https://github.com/pure-admin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e@pureadmin/descriptions\u003c/h1\u003e\n\u003cp align=\"center\"\u003eSecondary encapsulation of element-plus Descriptions, providing flexible configuration items\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.npmjs.com/package/@pureadmin/descriptions\" target=\"__blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@pureadmin/descriptions?color=a1b858\u0026label=\" alt=\"NPM version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@pureadmin/descriptions\" target=\"__blank\"\u003e\u003cimg alt=\"NPM Downloads\" src=\"https://img.shields.io/npm/dm/@pureadmin/descriptions?color=50a36f\u0026label=\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nEnglish | [简体中文](./README.md)\n\n- [Preview](https://pure-admin.github.io/pure-admin-descriptions)\n\n## 🤔 Original intention of development\n\n- `element-plus` [Descriptions](https://element-plus.org/en-US/component/descriptions.html#descriptions-item-attributes) `Descriptions Item` attribute can only be written in the `\u003ctemplate\u003e\u003c/template\u003e` template at present, which is not very flexible. If there are enough `Item` describing the list, the code is written and looks bloated, so I developed this library, Let's explore together\n\n## 🚀 Features\n\n- 🦾 **High flexibility**: Written using `tsx` syntax, while ensuring the type, it provides developers with more flexible writing methods and provides users with more convenient configuration\n- ⚡ **Fully tree-shaking**: Comes with Tree-shaking, only packages the imported code\n- 🫶 **Code Zero Intrusion**: Keep all attributes and slots of `element-plus` [Descriptions](https://element-plus.org/en-US/component/descriptions.html) and provide more Flexible configuration\n- ⚓ **Verification before code submission**: Use [husky](https://typicode.github.io/husky/#/) to verify the rules before submitting code, enforce standard development process and prevent development mistakes\n\n## 📦 Install\n\n```bash\nnpm install @pureadmin/descriptions\nor\npnpm add @pureadmin/descriptions\n```\n\n## 🦄 Usage\n\n### Partial registration (single file)\n\n```ts\nimport { PureDescriptions } from \"@pureadmin/descriptions\";\n\n\u003cpure-descriptions :data=\"data\" :columns=\"columns\"\u003e\u003c/pure-descriptions\u003e\n```\n\n### Global registration (main.ts)\n\n```ts\nimport { createApp } from \"vue\";\nimport App from \"./App.vue\";\n\nimport PureDescriptions from \"@pureadmin/descriptions\";\n\nconst app = createApp(App);\n\napp.use(PureDescriptions).mount(\"#app\");\n```\n\n[Click to view the specific usage](https://github.com/pure-admin/pure-admin-descriptions/blob/main/src/App.vue)\n\n## Volar support\n\n- If you are using `Volar`, you can configure compilerOptions.types in tsconfig.json to specify the global component type (especially if you want to get type hints during global registration, you need to add the following configuration)\n\n```js\n// tsconfig.json\n{\n  \"compilerOptions\": {\n    // ...\n    \"types\": [\"@pureadmin/descriptions/volar\"]\n  }\n}\n```\n\n## License\n\n[MIT © xiaoxian521-latest](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpure-admin%2Fpure-admin-descriptions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpure-admin%2Fpure-admin-descriptions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpure-admin%2Fpure-admin-descriptions/lists"}