Starwind UI - AI Reference Guide

Starwind UI is an open-source component library for Astro projects, styled with Tailwind CSS v4. It provides accessible, customizable components that can be added directly to your projects.

Things to remember when using Starwind UI:

• Starwind UI is designed for Astro projects using Tailwind CSS v4.
• Starwind UI is designed to setup and add components with the CLI only and NOT for direct HTML injection.
• Use the init command to setup a new project with Starwind UI.
• Use the add command to add components to your project.
• Use the update command to update components in your project.
• Combobox is a documented Select pattern built with Select and SelectSearch. Install select, not combobox.

Public AI Surfaces

• llms.txt: This concise static overview for AI tools.
• llms-full.txt: A full static reference for Starwind UI docs, components, theming, and CLI usage.
• Per-page Markdown docs: append .md to the docs path, such as /docs/components/button.md.
• Starwind Skills: Installable agent instructions from starwind-ui/skills for Starwind UI and Starwind Pro workflows.
• MCP server: The published @starwind-ui/mcp package exposes the current live tools for docs lookup, init command generation, add command generation, and Starwind Pro block search.

Important Links for AI Tools

• Home: The main landing page for Starwind UI, providing an overview and access to documentation.
• Getting Started: A guide for newcomers to the Starwind UI framework, covering the basics.
• AI Integration: Current AI-readable docs surfaces.
• Skills: Install Starwind Skills for compatible AI agents.
• MCP Server: Configure the Starwind UI MCP server for compatible editors and AI tools.
• CLI: Information on using the Command Line Interface for Starwind UI development.
• Installation: Step-by-step instructions for installing the Starwind UI framework.
• Theming: Guidance on customizing the look and feel of applications built with Starwind UI.
• Components: A detailed list of UI components available in the Starwind UI framework.
• Full Reference: A comprehensive LLM reference guide for all components and functionality provided by Starwind UI.

Installable Components and Documentation

Starwind UI currently includes the following installable components:

• Accordion
• Alert
• Alert Dialog
• Aspect Ratio
• Avatar
• Badge
• Breadcrumb
• Button
• Button Group
• Card
• Carousel
• Checkbox
• Collapsible
• Color Picker
• Context Menu
• Dialog
• Dropdown
• Dropzone
• Hover Card
• Image
• Input
• Input Group
• Input OTP
• Item
• Kbd
• Label
• Native Select
• Pagination
• Popover
• Progress
• Prose
• Radio Group
• Select
• Separator
• Sheet
• Scroll Area
• Sidebar
• Skeleton
• Slider
• Spinner
• Switch
• Table
• Tabs
• Textarea
• Theme Toggle
• Toast
• Toggle
• Tooltip
• Video

Documented Select Patterns

• Combobox: Select plus SelectSearch pattern documented at https://starwind.dev/docs/components/combobox. Install with starwind add select; there is no separate combobox install target.

Markdown Docs URL

• Per-page Markdown URL: append .md to the docs path.
• Example URL: https://starwind.dev/docs/components/button.md
• HTML docs pages include: <link rel="alternate" type="text/markdown" href="..."> pointing to the .md URL.

Import Pattern

All components follow a consistent import pattern:

import {ComponentName} from "@/components/starwind/component-name";

Starwind Pro - Premium Blocks

Looking for complete, production-ready page sections? Starwind Pro offers 200+ expertly crafted blocks for Astro projects including heroes, pricing tables, testimonials, navigation, CTAs, and more. 45+ blocks are completely free to use.

• Browse All Components
• Free Components (50+)

Categories include: Authentication, Background, Bento, Blog, Blog Post, Contact, CTA, Effect, FAQ, Feature, Footer, Form, Hero, Legal Page, Logo Cloud, Navigation, Pricing, Service Page, Services, Specialized Components, Steps, Team, Testimonial, and Theme Switcher.