Skip to content

Commit 7079259

Browse files
committed
Lint, prettier
1 parent 6f2318a commit 7079259

File tree

20 files changed

+48
-302
lines changed

20 files changed

+48
-302
lines changed

IMPLEMENTATION_SUMMARY.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Visual Timeline for Releases - Implementation Summary
22

33
## Overview
4+
45
Implemented a visual timeline for Base UI releases page that provides an overview of all releases with key highlights, similar to MUI X's "What's New" page.
56

67
## Features Implemented
78

89
### 1. Visual Timeline Component
10+
911
- **Location**: `/docs/src/components/ReleaseTimeline/`
1012
- **Features**:
1113
- Visual spine running down the center (desktop) or left side (mobile)
@@ -16,19 +18,22 @@ Implemented a visual timeline for Base UI releases page that provides an overvie
1618
- Clean, modern styling using CSS modules
1719

1820
### 2. Individual Release Pages
21+
1922
- **Route Pattern**: `/react/overview/releases/[version]`
2023
- **Created 17 individual pages**: one for each release from v1.0.0 down to v1.0.0-alpha.4
2124
- Each page contains the full release notes extracted from the original releases page
2225
- Format: MDX files for easy editing and markdown support
2326

2427
### 3. Main Releases Page Enhancement
28+
2529
- **Location**: `/docs/src/app/(docs)/react/overview/releases/page.tsx`
2630
- **Sections**:
2731
1. **Release Timeline**: Interactive visual timeline showing all releases
2832
2. **Canary Releases**: Information about installing and using canary versions
2933
3. **Full Release Notes**: Links to detailed documentation and GitHub changelog
3034

3135
### 4. Data Structure
36+
3237
- **Location**: `/docs/src/data/releases.ts`
3338
- Centralized release data with:
3439
- Version number
@@ -38,6 +43,7 @@ Implemented a visual timeline for Base UI releases page that provides an overvie
3843
- Easy to maintain and update for future releases
3944

4045
### 5. Utility Script
46+
4147
- **Location**: `/docs/src/scripts/generate-release-pages.js`
4248
- Automated script to extract individual release sections from the combined page
4349
- Used to generate the initial 17 release page files
@@ -66,7 +72,7 @@ docs/src/
6672

6773
## Design Decisions
6874

69-
1. **Timeline Layout**:
75+
1. **Timeline Layout**:
7076
- Alternating left/right cards on desktop for visual interest
7177
- All cards on the right on mobile for simplicity
7278
- Visual spine provides continuity and context
@@ -102,6 +108,7 @@ docs/src/
102108
## Future Enhancements
103109

104110
Potential improvements for the future:
111+
105112
- Add filtering by version type (alpha, beta, rc, stable)
106113
- Search functionality within release notes
107114
- RSS feed for releases
@@ -112,6 +119,7 @@ Potential improvements for the future:
112119
## Testing
113120

114121
To test the implementation:
122+
115123
1. Run `pnpm install` in the docs directory
116124
2. Run `pnpm dev` to start the development server
117125
3. Navigate to `/react/overview/releases`

docs/src/app/(docs)/react/overview/page.mdx

Lines changed: 4 additions & 269 deletions
Original file line numberDiff line numberDiff line change
@@ -53,297 +53,32 @@ Learn how to make the most of Base UI's accessibility features and guidelines.
5353

5454
## Releases
5555

56-
Changelogs for each Base UI release.
56+
Changelogs for each Base UI release.
5757

5858
<details>
5959

6060
<summary>Outline</summary>
6161

62-
- Keywords: Base UI Releases, Base UI Changelog, Release Notes Beta, Breaking Changes Base UI, Component Updates History, Headless React Release Log, Version History, Changelog History, Upgrade Guide, Migration Guide, What's New, Release Updates
6362
- Sections:
64-
- v1.1.0
65-
- General changes
66-
- Accordion
67-
- Autocomplete
68-
- Button
69-
- Checkbox
70-
- Combobox
71-
- Context Menu
72-
- CSP Provider
73-
- Dialog
74-
- Field
75-
- Form
76-
- Menu
77-
- Menubar
78-
- Number Field
79-
- Popover
80-
- Preview Card
81-
- Radio Group
82-
- Scroll Area
83-
- Select
84-
- Slider
85-
- Switch
86-
- Toast
87-
- Tooltip
88-
- mergeProps
89-
- useRender
63+
- Canary Releases
64+
- Full Release Notes
9065
- v1.0.0
91-
- General changes
92-
- Combobox
93-
- Menu
94-
- Navigation Menu
95-
- Number Field
96-
- Popover
97-
- Select
98-
- Tabs
99-
- Toast
100-
- Toggle Group
101-
- Tooltip
10266
- v1.0.0-rc.2
10367
- v1.0.0-rc.1
10468
- v1.0.0-rc.0
105-
- General changes
106-
- Autocomplete
107-
- Checkbox
108-
- Collapsible
109-
- Combobox
110-
- Dialog
111-
- Menu
112-
- Number Field
113-
- Popover
114-
- Select
115-
- Switch
116-
- Tabs
117-
- Toast
118-
- Tooltip
11969
- v1.0.0-beta.7
120-
- General changes
121-
- Alert Dialog
122-
- Checkbox Group
123-
- Combobox
124-
- Context Menu
125-
- Dialog
126-
- Form
127-
- Menu
128-
- Navigation Menu
129-
- Number Field
130-
- Popover
131-
- Select
132-
- Slider
133-
- Tooltip
13470
- v1.0.0-beta.6
13571
- v1.0.0-beta.5
136-
- General changes
137-
- Accordion
138-
- Alert Dialog
139-
- Autocomplete
140-
- Button
141-
- Checkbox
142-
- Collapsible
143-
- Combobox
144-
- Context Menu
145-
- Dialog
146-
- Field
147-
- Form
148-
- Menu
149-
- Navigation Menu
150-
- Number Field
151-
- Popover
152-
- Preview Card
153-
- Radio Group
154-
- Scroll Area
155-
- Select
156-
- Slider
157-
- Switch
158-
- Tabs
159-
- Toast
160-
- Toolbar
161-
- Tooltip
16272
- v1.0.0-beta.4
163-
- General changes
164-
- Accordion
165-
- Autocomplete
166-
- Collapsible
167-
- Combobox
168-
- Context Menu
169-
- Menu
170-
- Menubar
171-
- Navigation Menu
172-
- Number Field
173-
- Popover
174-
- Scroll Area
175-
- Select
176-
- Slider
177-
- Switch
178-
- Toast
179-
- Toggle Group
180-
- Toolbar
181-
- useRender
18273
- v1.0.0-beta.3
183-
- General changes
184-
- Alert Dialog
185-
- Autocomplete
186-
- Checkbox
187-
- Combobox
188-
- Context Menu
189-
- Dialog
190-
- Field
191-
- Input
192-
- Menu
193-
- Navigation Menu
194-
- Number Field
195-
- Popover
196-
- Preview Card
197-
- Radio Group
198-
- Scroll Area
199-
- Select
200-
- Slider
201-
- Tabs
202-
- Tooltip
203-
- useRender
20474
- v1.0.0-beta.2
205-
- General changes
206-
- Accordion
207-
- Alert Dialog
208-
- Checkbox
209-
- Collapsible
210-
- Dialog
211-
- Field
212-
- Form
213-
- Menu
214-
- Menubar
215-
- Meter
216-
- Navigation Menu
217-
- Number Field
218-
- Popover
219-
- Preview Card
220-
- Progress
221-
- Radio Group
222-
- Scroll Area
223-
- Select
224-
- Slider
225-
- Toast
226-
- Toggle
227-
- Toggle Group
228-
- Toolbar
229-
- Tooltip
23075
- v1.0.0-beta.1
231-
- General changes
232-
- Accordion
233-
- Checkbox
234-
- Checkbox Group
235-
- Collapsible
236-
- Context Menu
237-
- Dialog
238-
- Field
239-
- Fieldset
240-
- Form
241-
- Input
242-
- Menu
243-
- Menubar
244-
- Navigation Menu
245-
- Number Field
246-
- Popover
247-
- Radio Group
248-
- Scroll Area
249-
- Select
250-
- Slider
251-
- Switch
252-
- Tabs
253-
- Toolbar
254-
- useRender
25576
- v1.0.0-beta.0
256-
- General changes
257-
- Accordion
258-
- Alert Dialog
259-
- Checkbox
260-
- Checkbox Group
261-
- Context Menu
262-
- Dialog
263-
- Field
264-
- Form
265-
- Input
266-
- Menu
267-
- Menubar
268-
- Navigation Menu
269-
- Number Field
270-
- Popover
271-
- Preview Card
272-
- Radio Group
273-
- Select
274-
- Slider
275-
- Toast
276-
- Toggle
277-
- Toolbar
278-
- Tooltip
279-
- useRender
28077
- v1.0.0-alpha.8
281-
- Accordion
282-
- AlertDialog
283-
- CheckboxGroup
284-
- Collapsible
285-
- Dialog
286-
- Field
287-
- Menu
288-
- Meter
289-
- NumberField
290-
- Popover
291-
- Progress
292-
- Radio
293-
- ScrollArea
294-
- Select
295-
- Slider
296-
- Toast
297-
- Tooltip
29878
- v1.0.0-alpha.7
299-
- Accordion
300-
- AlertDialog
301-
- Avatar
302-
- Collapsible
303-
- Dialog
304-
- Field
305-
- Menu
306-
- NumberField
307-
- Popover
308-
- PreviewCard
309-
- RadioGroup
310-
- Select
311-
- Slider
312-
- Tabs
313-
- Toolbar
314-
- Tooltip
315-
- useRender
31679
- v1.0.0-alpha.6
317-
- AlertDialog
318-
- Avatar
319-
- Checkbox
320-
- Dialog
321-
- Field
322-
- Form
323-
- Menu
324-
- Popover
325-
- PreviewCard
326-
- Progress
327-
- Radio
328-
- Select
329-
- Slider
330-
- Tabs
331-
- Tooltip
33280
- v1.0.0-alpha.5
333-
- AlertDialog
334-
- Dialog
335-
- Menu
336-
- NumberField
337-
- Popover
338-
- PreviewCard
339-
- Progress
340-
- ScrollArea
341-
- Select
342-
- Separator
343-
- Slider
344-
- Tabs
345-
- Tooltip
346-
- 1.0.0-alpha.4
81+
- v1.0.0-alpha.4
34782

34883
</details>
34984

docs/src/app/(docs)/react/overview/releases/v1-0-0-alpha-5/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,4 @@ export const metadata = {
138138
"What's New",
139139
'Release Updates',
140140
],
141-
};
141+
};

docs/src/app/(docs)/react/overview/releases/v1-0-0-alpha-6/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@
8282

8383
- `onOpenChangeComplete` prop ([#1305](https://github.com/mui/base-ui/pull/1305/))
8484
- Add `OffsetFunction` for `sideOffset` and `alignOffset` ([#1223](https://github.com/mui/base-ui/pull/1223/))
85-
- Ensure `keepMounted` is a private param on `Positioner` ([#1410](https://github.com/mui/base-ui/pull/1410/))
85+
- Ensure `keepMounted` is a private param on `Positioner` ([#1410](https://github.com/mui/base-ui/pull/1410/))

docs/src/app/(docs)/react/overview/releases/v1-0-0-alpha-7/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@
104104
### useRender
105105

106106
- Add public hook ([#1418](https://github.com/mui/base-ui/pull/1418/))
107-
- Refine docs and APIs ([#1551](https://github.com/mui/base-ui/pull/1551/))
107+
- Refine docs and APIs ([#1551](https://github.com/mui/base-ui/pull/1551/))

docs/src/app/(docs)/react/overview/releases/v1-0-0-alpha-8/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,4 @@
112112
- Add `disabled` prop ([#1682](https://github.com/mui/base-ui/pull/1682))
113113
- Fix `onOpenChange` types for `event`/`reason` passing ([#1721](https://github.com/mui/base-ui/pull/1721))
114114
- Use consistent `inert` attr and map `[data-popup-open]` back to `open` ([#1650](https://github.com/mui/base-ui/pull/1650))
115-
- Fix text selection & right-clicks ([#1702](https://github.com/mui/base-ui/pull/1702))
115+
- Fix text selection & right-clicks ([#1702](https://github.com/mui/base-ui/pull/1702))

0 commit comments

Comments
 (0)