mirror of
https://github.com/langgenius/dify.git
synced 2026-09-07 10:23:54 +08:00
46 lines
2.3 KiB
Markdown
46 lines
2.3 KiB
Markdown
# @langgenius/dify-ui
|
|
|
|
This file owns the package boundary. Read the matching contract guide below directly; use the
|
|
[package index] when discovering available primitives or usage examples.
|
|
|
|
## Package boundary
|
|
|
|
- Keep this an independent primitive package. Do not import from application packages or depend on
|
|
routing, i18n, application state, schemas, data fetching, or business APIs.
|
|
- Keep package contracts and contributor guidance self-contained here. Application docs and agent
|
|
skills may reference these guides; these guides must not require Web docs or skills to define package behavior.
|
|
- Prefer `@base-ui/react` when it owns the required headless behavior. Style primitives with `cva`,
|
|
`cn`, and Dify design tokens. Keep one primitive per `src/<name>/` folder with optional colocated
|
|
stories and tests.
|
|
- Prefer Base UI data attributes and CSS variables for visual states. Do not mirror primitive state
|
|
in React solely to add classes.
|
|
- When an upstream API or selector contract is unclear, read the current official Base UI
|
|
documentation and installed `@base-ui/react` declarations before coding.
|
|
|
|
## Contract owners
|
|
|
|
- Imports, exports, naming, public types, generics, and anatomy: [Public API authoring]
|
|
- Button and icon-only action behavior: [Button contract] and [Icon Button contract]
|
|
- Cross-component accessible-name and description choices: [Accessible names and descriptions]
|
|
- Compound input behavior: [Input Group contract]
|
|
- Form structure, labels, and value ownership: [Forms]
|
|
- Picker choice and typed values: [Selection]
|
|
- Portals, presence, layering, and floating-surface semantics: [Overlays]
|
|
- Tailwind integration and radius mapping: [Styling]
|
|
- Package test ownership and setup: [Testing and development]
|
|
|
|
A component needs a local README only when it owns a substantial Dify-specific contract that its
|
|
types, stories, and upstream documentation do not express. Do not create one for completeness.
|
|
|
|
[Accessible names and descriptions]: docs/accessible-names-and-descriptions.md
|
|
[Button contract]: src/button/README.md
|
|
[Forms]: docs/forms.md
|
|
[Icon Button contract]: src/icon-button/README.md
|
|
[Input Group contract]: src/input-group/README.md
|
|
[Overlays]: docs/overlays.md
|
|
[Public API authoring]: docs/authoring.md
|
|
[Selection]: docs/selection.md
|
|
[Styling]: docs/styling.md
|
|
[Testing and development]: docs/testing.md
|
|
[package index]: README.md
|