Point README at bladewindui/ui - #30
Open
mkocansey wants to merge 63 commits into
Open
Conversation
Install instructions and the component list were copy-pasted from the component library's own README, and had drifted badly: still said composer require bladewindui/bladewindui, linked dead components (Dropdown, Process Indicator), and was missing everything shipped since (Calendar, Data Grid, Command Palette, Drawer, and more). Every new component meant remembering to update two READMEs in two repos: this one now just points at bladewindui/ui's README (canonical, always current) and the live site's generated /install and /components pages, instead of restating either.
Adds a Livewire section to Dropmenu, Popover, Select, Datepicker, Filepicker, Sortable, Rating, Colorpicker, Timepicker, Slider, Data Grid, Command Palette, Sidebar, Drawer, Tab Group, and Stepper, matching the package-level fixes and README updates in bladewindui/ui#632. The six form-input components explain that their value now dispatches a native change event so wire:model works without extra wiring. All sixteen explain which piece of interaction state lives in the DOM rather than in Livewire's component state, and when to reach for wire:ignore.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/divider package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/confirm-dialog package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/context-menu package.
Brings it in line with the established component-page structure (see tab.blade.php, dropmenu.blade.php) — an in-page anchor nav and highlighting the current page in the components sidebar.
Brings it in line with the established component-page structure (see tab.blade.php, dropmenu.blade.php) — an in-page anchor nav and highlighting the current page in the components sidebar.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/currency-input package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/password-meter package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/file-preview package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/transfer-list package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/inline-edit package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/kbd package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/copy-button package.
Component page, mcp reference doc, and the components list/route registrations for the new bladewindui/meter package.
Documents the new description-list component: docs page with basic usage, action slots, and striped rows demos; route; catalogue entries; and mcp reference doc.
Documents the new banner component: docs page covering tones, title, actions, dismissibility, persistence, icons, and rounded corners; route; catalogue entries; and mcp reference doc.
Documents the new code-block component: docs page covering languages, title, line numbers, line highlighting, wrapping, and the copy action; route; catalogue entries; and mcp reference doc.
Documents the new chat component: docs page covering grouped messages, delivery status, attachments, and a scrollable thread; route; catalogue entries; and mcp reference doc.
Documents the new carousel component: docs page covering autoplay, looping, and hiding arrows/indicators; route; catalogue entries; and mcp reference doc.
Documents the new kanban component: docs page covering the move hook, empty and loading column states, and column actions; route; catalogue entries; and mcp reference doc.
Documents the new scheduler component: docs page covering day view with resources, week view, visible hours and grid granularity, selection hooks, and the timezone label; route; catalogue entries; and mcp reference doc.
Documents the new credit-card component: docs page covering flipping to the CVC, pre-filling fields, forcing a network, theming, the inline variant, and validation; route; catalogue entries; and mcp reference doc.
Refresh all existing mcp/*.md files against their current blade sources, add docs for breadcrumbs, command-palette, data-grid, drawer, sidebar, and stepper, and fix component-tag/slug mismatches in verification-code, radio-button, and checkcard entries.
# Conflicts: # mcp/index.md
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php # routes/web.php
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php # routes/web.php
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php # routes/web.php
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php # routes/web.php
# Conflicts: # mcp/index.md # routes/web.php
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php
# Conflicts: # routes/web.php
# Conflicts: # routes/web.php
# Conflicts: # mcp/index.md # resources/views/docs/components-list.blade.php # resources/views/docs/components.blade.php # routes/web.php
# Conflicts: # mcp/index.md
Keeps the docs prose style consistent across the batch of pages added for recently merged components (kbd, meter, description-list, divider, context-menu, and others).
Refreshes the published CSS/JS to match the latest component set now that the local package checkout includes the newly merged components.
Recently added components had been appended near their closest relative instead of in alphabetical order.
Confirm Dialog and Banner were removed from the component library (duplicated Modal/Alert); republishing drops their now-dead JS helpers.
The dashed demo box was a plain wrapper div around a small inline-block region containing just the label text, so only the text itself responded to a right-click. Moving the box styling onto the region content itself makes the whole visible box the actual clickable area.
Was npm install bladewindui (wrong package manager and name); this is a Composer package.
Credit Card exposes a named window instance (unlike the other new components, which don't), with value, validate(), toggleFlip() and isFlipped(). Only validate() was documented before, and only in passing prose. Follows the same JavaScript API section convention used by Dropmenu, Modal, Calendar, etc.
Every recently added component's doc page skipped the closing example that shows the component with every attribute set at once (see Bell for the established pattern). Backfills it across all 17 pages, including a second example per sub-component where a page documents more than one (e.g. Chat + Chat Message, Kanban + Column + Card).
Established pages (Bell, Tag, etc.) drop straight into the first example with no heading; the new pages had added one inconsistently. Removes the heading and its side-nav link, keeps the example itself.
Same cleanup as the recently added component docs: established pages drop straight into the first example with no heading.
Every other multi-component page prefixes its sub-component headings (Accordion Item, Chat Message, Context Menu Item, Description List Item, Carousel Slide); Kanban's Column and Card were the only bare ones, both in the attribute table heading and the all-attributes example.
Also fixes the target: it pointed at github.com/sponsors/mkocansey (the maintainer's personal sponsor page), now points at github.com/sponsors/bladewindui.
Both show events on dates, so it wasn't obvious when to reach for one over the other. Calendar browses months/weeks of dates; Scheduler is an hour-by-hour grid for one day or week, with resource columns, built for room booking boards, rosters, and appointment books.
Every docs page now uses <x-bladewind::code-block> instead of a hand-written <pre class="language-..."> block, dropping the docs app's own separate Prism setup (resources/js/prism.js, resources/css/prism.css) in favor of the component's own bundled copy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
bladewindui/ui's README (canonical, always current) and the live/installand/componentspages. The copy here had drifted badly (composer require bladewindui/bladewindui, deadDropdown/Process Indicatorlinks, missing Calendar/Data Grid/Command Palette/Drawer/etc.) and every new component meant remembering to update both READMEs.f8fd597, "Remove unused assets") already ondevelopment.Test plan
development: https://github.com/bladewindui/docs/actions/runs (latest run against 2b36fd5)