@quantlife/qlui
v0.0.9
Published
QuantLife UI component library (shadcn/ui + tailwind v4)
Downloads
1,904
Readme
ql-ui
Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!
Add your files
- [ ] Create or upload files
- [ ] Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin https://gitlab.quantlifetech.com/quantlife/libs/ql-ui.git
git branch -M main
git push -uf origin mainIntegrate with your tools
Collaborate with your team
- [ ] Invite team members and collaborators
- [ ] Create a new merge request
- [ ] Automatically close issues from merge requests
- [ ] Enable merge request approvals
- [ ] Set auto-merge
Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] Get started with GitLab CI/CD
- [ ] Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)
- [ ] Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
- [ ] Use pull-based deployments for improved Kubernetes management
- [ ] Set up protected environments
Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.
Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Name
Choose a self-explaining name for your project.
Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
License
For open source projects, say how it is licensed.
Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
shadcn 组件使用方式(老板 11:33 指正说明)
组件存放目录
shadcn 组件(CLI 添加的源码)落在 src/components/ui/(components.json aliases 配置 ui: @/components/ui)——A1 标准 26 件+A2 组合+A3 registry+C 自建+D 迁入共 51 个组件文件全部在此目录。
添加组件(源码进本地,非 npm 依赖)
pnpm dlx shadcn@latest add button # 单个
pnpm dlx shadcn@latest add button card tabs # 批量组件源码复制进 src/components/ui/button.tsx——可直接修改(这是我们封装 TabsBar/rightExtra 等承接面的基础)。
升级更新工作流
pnpm dlx shadcn@latest diff # 查看本地组件与上游差异
pnpm dlx shadcn@latest update # 更新本地组件到上游最新注意:本地已改造的组件(如 combobox 加 onSearch/loading、tabs 加 TabsBar)update 会覆盖——diff 先看再选择性合并。
Storybook 用例目录
stories 用例在 src/stories/(与组件源码 src/components/ui/ 分离——老板 11:33 架构口径);pnpm storybook 起 6006 查看。
主题机制(token 契约+可选预设——宿主主权,老板 2026-10-23 11:52 定音)
- 职责分层:ql-ui 只定义变量(token)的名字(组件引用的颜色变量契约:--background/--foreground/--card/--primary/--muted/--border 等约 40 个——组件全部引用 token,零写死颜色);具体值是动态的;主题的 CSS 配置(新增特殊主题)由宿主项目添加,不加进本库。
- 预设(可选默认值):内置 light(默认)/dark 两套预设(ThemeProvider 驱动 html class/
data-theme,localStorage 持久化);预设只是默认值——宿主可覆盖、可新增,不用改本库。 - 宿主覆盖预设主题(三步,零库改动):① 宿主全局 CSS 以更高特异性/后加载覆写目标 token(例:
html[data-theme="dark"] { --background: <你的色>; })② 按需逐 token 改(背景/组件背景/字体色想设什么设什么)③ 刷新即全组件生效。 - 宿主新增自定义主题(四步,零库改动):① 宿主 CSS 写完整变量集
html[data-theme="custom-x"] { --background: …; --card: …; /* 全部 token */ }(每套主题=一组 CSS 颜色集,各 token 关系自由定义)② 宿主设置界面加该主题入口 ③setTheme("custom-x")驱动 html data-theme(ThemeProvider 支持任意主题串,可传入扩展主题清单)④ 验证全组件同步变色。 - Storybook 演示:预设主题下全部组件形态对照见
pnpm storybook(主题切换 toolbar)。
