#lynx-ui

Helps coding agents use @lynx-js/lynx-ui components with curated references from the lynx-ui repository.

Use it when an agent needs to:

• choose the right lynx-ui component for a feature
• verify supported props, events, ref methods, exports, or type aliases
• adapt official examples into project code
• debug a component usage issue against the documented public API
• avoid inventing unsupported lynx-ui APIs from model memory

#Installation

npx skills add lynx-community/skills -s lynx-ui

This installs the lynx-ui skill so compatible coding agents can load its routing guide and bundled references automatically.

#What It Contains

lynx-ui is structured for progressive disclosure:

• SKILL.md: entrypoint and workflow rules for the agent
• reference.md: component selection and routing guide
• references/index.md: included component coverage
• references/components/<component>/guide.md: usage patterns, composition guidance, and common pitfalls
• references/components/<component>/api.md: public API source of truth
• references/components/<component>/examples.md: concise implementation patterns

#Recommended Workflow

Ask the agent to use lynx-ui before implementing lynx-ui code.

1. Identify the concrete component or a small set of candidate components.
2. Use reference.md when component selection is unclear.
3. Read the component guide.md first for usage patterns.
4. Read api.md when exact public surface details matter.
5. Read examples.md only when an implementation pattern is needed.

The agent should prefer imports from @lynx-js/lynx-ui by default and treat api.md as the source of truth for public props, events, ref methods, and exported types.

#Learn More

• lynx-ui documentation
• lynx-family/lynx-ui on GitHub
• lynx-community/skills on GitHub
• Agent Skills specification