Skip to content

Commit 3f1efc3

Browse files
[docs] Enforce component style rules for Tree View (#14963)
Signed-off-by: Sycamore <[email protected]>
1 parent 7b8d976 commit 3f1efc3

File tree

55 files changed

+219
-219
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+219
-219
lines changed

CHANGELOG.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Same changes as in `@mui/[email protected]`.
7979
- [docs] Add custom columns panel demo (#14825) @cherniavskii
8080
- [docs] Capitalize all instances of "Data Grid" (#14884) @samuelsycamore
8181
- [docs] Divide charts `tooltip` and `highlighting` pages (#14824) @JCQuintas
82-
- [docs] Document the `TreeItem2` component and the `useTreeItem2` hook (#14551) @noraleonte
82+
- [docs] Document the `<TreeItem2 />` component and the `useTreeItem2` hook (#14551) @noraleonte
8383
- [docs] Fix column pinning for "Disable detail panel content scroll" section (#14854 and #14885) @kalyan90
8484
- [docs] Fix detail panel demo not working well with pinned columns (#14883) @cherniavskii
8585
- [docs] New recipe of a read-only field (#14606) @flaviendelangle
@@ -367,7 +367,7 @@ Same changes as in `@mui/[email protected]`.
367367

368368
### Docs
369369

370-
- [docs] Add missing callout on "Imperative API" tree view sections (#14503) @flaviendelangle
370+
- [docs] Add missing callout on "Imperative API" Tree View sections (#14503) @flaviendelangle
371371
- [docs] Fix broken redirection to MUI X v5 @oliviertassinari
372372
- [docs] Fix multiple `console.error` messages on `charts` docs (#14554) @JCQuintas
373373
- [docs] Fixed typo in Row Grouping recipes (#14549) @Miodini
@@ -708,7 +708,7 @@ Same changes as in `@mui/[email protected]`.
708708
- [core] Fix ESLint issue (#14207) @LukasTy
709709
- [core] Fix Netlify build cache issue (#14182) @cherniavskii
710710
- [code-infra] Refactor Netlify `cache-docs` plugin setup (#14105) @LukasTy
711-
- [internals] Move utils needed for tree view virtualization to shared package (#14202) @flaviendelangle
711+
- [internals] Move utils needed for Tree View virtualization to shared package (#14202) @flaviendelangle
712712

713713
## 7.12.1
714714

@@ -799,7 +799,7 @@ This expansion of the Pro plan comes with some adjustments to our pricing strate
799799

800800
We'd like to offer a big thanks to the 12 contributors who made this release possible. Here are some highlights ✨:
801801

802-
- 🎁 Introduce [item reordering using drag and drop](https://mui.com/x/react-tree-view/rich-tree-view/ordering/) on the `RichTreeViewPro` component
802+
- 🎁 Introduce [item reordering using drag and drop](https://mui.com/x/react-tree-view/rich-tree-view/ordering/) on the `<RichTreeViewPro />` component
803803

804804
<img width="287" src="https://github.com/user-attachments/assets/78bd83c5-7ce4-4ed7-acf9-be70b2dbce54" alt="Item reordering using drag and drop" />
805805

@@ -1292,7 +1292,7 @@ Same changes as in `@mui/[email protected]`.
12921292

12931293
- [core] Add eslint rule to restrict import from `../internals` root (#13633) @JCQuintas
12941294
- [docs-infra] Sync `\_app` folder with monorepo (#13582) @Janpot
1295-
- [license] Allow usage of charts and tree view pro package for old premium licenses (#13619) @flaviendelangle
1295+
- [license] Allow usage of Charts and Tree View Pro package for old premium licenses (#13619) @flaviendelangle
12961296

12971297
## 7.7.1
12981298

@@ -1360,7 +1360,7 @@ Same changes as in `@mui/[email protected]`, plus:
13601360
- [TreeView] Improve typing to support optional dependencies in plugins and in the item (#13523) @flaviendelangle
13611361
- [TreeView] Move `useTreeViewId` to the core plugins (#13566) @flaviendelangle
13621362
- [TreeView] Remove unused state from `useTreeViewId` (#13579) @flaviendelangle
1363-
- [TreeView] Support `itemId` with escaping characters when using `SimpleTreeView` (#13487) @oukunan
1363+
- [TreeView] Support `itemId` with escaping characters when using Simple Tree View (#13487) @oukunan
13641364

13651365
### Docs
13661366

@@ -1440,7 +1440,7 @@ Same changes as in `@mui/[email protected]`.
14401440
- [TreeView] Improve TypeScript for plugins (#13380) @flaviendelangle
14411441
- [TreeView] Improve the typing of the cancelable events (#13152) @flaviendelangle
14421442
- [TreeView] Prepare support for PigmentCSS (#13412) @flaviendelangle
1443-
- [TreeView] Refactor the tree view internals to prepare for headless API (#13311) @flaviendelangle
1443+
- [TreeView] Refactor the Tree View internals to prepare for headless API (#13311) @flaviendelangle
14441444

14451445
### Docs
14461446

@@ -1455,7 +1455,7 @@ Same changes as in `@mui/[email protected]`.
14551455
- [core] Add `eslint-plugin-react-compiler` experimental version and rules (#13415) @JCQuintas
14561456
- [core] Minor setup cleanup (#13467) @LukasTy
14571457
- [infra] Adjust CI setup (#13448) @LukasTy
1458-
- [test] Add tests for the custom slots of `TreeItem2` (#13314) @flaviendelangle
1458+
- [test] Add tests for the custom slots of `<TreeItem2 />` (#13314) @flaviendelangle
14591459

14601460
## 7.6.2
14611461

@@ -1640,7 +1640,7 @@ _May 23, 2024_
16401640

16411641
We'd like to offer a big thanks to the 6 contributors who made this release possible. Here are some highlights ✨:
16421642

1643-
- 🧰 Improve tree view testing
1643+
- 🧰 Improve Tree View testing
16441644
- 📊 Add `label` to be displayed in BarChart
16451645

16461646
### Data Grid
@@ -1816,7 +1816,7 @@ Same changes as in `@mui/[email protected]`.
18161816

18171817
#### `@mui/[email protected]`
18181818

1819-
- [TreeView] Fix props propagation and theme entry in `TreeItem2` (#12889) @flaviendelangle
1819+
- [TreeView] Fix props propagation and theme entry in `<TreeItem2 />` (#12889) @flaviendelangle
18201820

18211821
### Docs
18221822

@@ -2126,7 +2126,7 @@ Same changes as in `@mui/[email protected]`, plus:
21262126
### Docs
21272127

21282128
- [docs] Add `AxisFormatter` documentation for customizing tick/tooltip value formatting (#12700) @JCQuintas
2129-
- [docs] Add file explorer example to rich tree view customization docs (#12707) @noraleonte
2129+
- [docs] Add file explorer example to rich Tree View customization docs (#12707) @noraleonte
21302130
- [docs] Do not use import of depth 3 in the doc (#12716) @flaviendelangle
21312131
- [docs] Explain how to clip plots with composition (#12679) @alexfauquette
21322132
- [docs] Fix typo in Data Grid v7 migration page (#12720) @bfaulk96
@@ -2202,7 +2202,7 @@ Same changes as in `@mui/[email protected]`, plus:
22022202
#### `@mui/[email protected]`
22032203

22042204
- [TreeView] Add JSDoc to all `publicAPI` methods (#12649) @flaviendelangle
2205-
- [TreeView] Create `RichTreeViewPro` component (not released yet) (#12610) @flaviendelangle
2205+
- [TreeView] Create `<RichTreeViewPro />` component (not released yet) (#12610) @flaviendelangle
22062206
- [TreeView] Create Pro package (not released yet) (#12240) @flaviendelangle
22072207
- [TreeView] Fix typo in errors (#12623) @alissa-tung
22082208
- [TreeView] New API method: `setItemExpansion` (#12595) @flaviendelangle
@@ -2222,13 +2222,13 @@ Same changes as in `@mui/[email protected]`, plus:
22222222
- [docs] Move Data Grid interfaces to standard API page layout (#12016) @alexfauquette
22232223
- [docs] Remove ` around @default values (#12158) @alexfauquette
22242224
- [docs] Remove `day` from the default `dayOfWeekFormatter` function params (#12644) @LukasTy
2225-
- [docs] Use `TreeItem2` for icon expansion example on `RichTreeView` (#12563) @flaviendelangle
2225+
- [docs] Use `<TreeItem2 />` for icon expansion example on `<RichTreeView />` (#12563) @flaviendelangle
22262226

22272227
### Core
22282228

22292229
- [core] Add cherry-pick `master` to `v6` action (#12648) @LukasTy
22302230
- [core] Fix typo in `@mui/x-tree-view-pro/themeAugmentation` (#12674) @flaviendelangle
2231-
- [core] Introduce `describeTreeView` to run test on `SimpleTreeView` and `RichTreeView`, using `TreeItem` and `TreeItem2` + migrate expansion tests (#12428) @flaviendelangle
2231+
- [core] Introduce `describeTreeView` to run test on `<SimpleTreeView />` and `<RichTreeView />`, using `<TreeItem />` and `<TreeItem2 />` + migrate expansion tests (#12428) @flaviendelangle
22322232
- [core] Limit `test-types` CI step allowed memory (#12651) @LukasTy
22332233
- [core] Remove explicit `express` package (#12602) @LukasTy
22342234
- [core] Update to new embedded translations in the docs package (#12232) @Janpot
@@ -2293,7 +2293,7 @@ Same changes as in `@mui/[email protected]`, plus:
22932293

22942294
#### `@mui/[email protected]`
22952295

2296-
- [TreeView] Do not use outdated version of the state to compute new label first char in `RichTreeView` (#12512) @flaviendelangle
2296+
- [TreeView] Do not use outdated version of the state to compute new label first char in Rich Tree View (#12512) @flaviendelangle
22972297

22982298
### Docs
22992299

@@ -2420,7 +2420,7 @@ Same changes as in `@mui/[email protected]`, plus:
24202420

24212421
#### Breaking changes
24222422

2423-
- The required `nodeId` prop used by the `TreeItem` has been renamed to `itemId` for consistency:
2423+
- The required `nodeId` prop used by `<TreeItem />` has been renamed to `itemId` for consistency:
24242424

24252425
```diff
24262426
<TreeView>
@@ -2573,7 +2573,7 @@ The `onNodeFocus` callback has been renamed to `onItemFocus` for consistency:
25732573
#### `@mui/[email protected]`
25742574

25752575
- [TreeView] Clean the usage of the term "item" and "node" in API introduced during v7 (#12368) @noraleonte
2576-
- [TreeView] Introduce a new `TreeItem2` component and a new `useTreeItem2` hook (#11721) @flaviendelangle
2576+
- [TreeView] Introduce a new `<TreeItem2 />` component and a new `useTreeItem2` hook (#11721) @flaviendelangle
25772577
- [TreeView] Rename `onNodeFocus` to `onItemFocus` (#12419) @noraleonte
25782578

25792579
### Docs
@@ -2631,9 +2631,9 @@ Same changes as in `@mui/[email protected]`.
26312631

26322632
#### Breaking changes
26332633

2634-
- The component used to animate the item children is now defined as a slot on the `TreeItem` component.
2634+
- The component used to animate the item children is now defined as a slot on the `<TreeItem />` component.
26352635

2636-
If you were passing a `TransitionComponent` or `TransitionProps` to your `TreeItem` component,
2636+
If you were passing a `TransitionComponent` or `TransitionProps` to your `<TreeItem />` component,
26372637
you need to use the new `groupTransition` slot on this component:
26382638

26392639
```diff
@@ -2649,7 +2649,7 @@ Same changes as in `@mui/[email protected]`.
26492649
</SimpleTreeView>
26502650
```
26512651

2652-
- The `group` class of the `TreeItem` component has been renamed to `groupTransition` to match with its new slot name.
2652+
- The `group` class of the `<TreeItem />` component has been renamed to `groupTransition` to match with its new slot name.
26532653

26542654
```diff
26552655
const StyledTreeItem = styled(TreeItem)({
@@ -2663,14 +2663,14 @@ Same changes as in `@mui/[email protected]`.
26632663
#### `@mui/[email protected]`
26642664

26652665
- [TreeView] Fix invalid nodes state when updating `props.items` (#12359) @flaviendelangle
2666-
- [TreeView] In the `RichTreeView`, do not use the item id as the HTML id attribute (#12319) @flaviendelangle
2666+
- [TreeView] In the Rich Tree View, do not use the item id as the HTML id attribute (#12319) @flaviendelangle
26672667
- [TreeView] New instance and publicAPI method: `getItem` (#12251) @flaviendelangle
26682668
- [TreeView] Replace `TransitionComponent` and `TransitionProps` with a `groupTransition` slot (#12336) @flaviendelangle
26692669

26702670
### Docs
26712671

26722672
- [docs] Add a note about `z-index` usage in SVG (#12337) @alexfauquette
2673-
- [docs] `RichTreeView` customization docs (#12231) @noraleonte
2673+
- [docs] Rich Tree View customization docs (#12231) @noraleonte
26742674

26752675
### Core
26762676

@@ -3323,7 +3323,7 @@ Same changes as in `@mui/[email protected]`, plus:
33233323

33243324
### Docs
33253325

3326-
- [docs] Add `contextValue` to the headless tree view doc (#11705) @flaviendelangle
3326+
- [docs] Add `contextValue` to the headless Tree View doc (#11705) @flaviendelangle
33273327
- [docs] Add section for the `disableSelection` prop (#11821) @flaviendelangle
33283328
- [docs] Fix brand name non-breaking space (#11758) @oliviertassinari
33293329
- [docs] Fix typo in Data Grid components page (#11775) @flaviendelangle
@@ -3346,7 +3346,7 @@ We'd like to offer a big thanks to the 11 contributors who made this release pos
33463346

33473347
- 🎁 The Data Grid headers have been refactored to bring immense improvements to scrolling, state management, and overall performance of the grid.
33483348
- ⚙️ The Data Grid disabled column-specific features like filtering, sorting, grouping, etc. could now be accessed programmatically. See the related [docs](https://next.mui.com/x/react-data-grid/api-object/#access-the-disabled-column-features) section.
3349-
- 🚀 Uplift the `SimpleTreeView` customization examples (#11424) @noraleonte
3349+
- 🚀 Uplift the Simple Tree View customization examples (#11424) @noraleonte
33503350
- 🌍 Add Croatian (hr-HR), Portuguese (pt-PT), and Chinese (Hong Kong) (zh-HK) locales (#11668) on the Data Grid @BCaspari
33513351
- 🐞 Bugfixes
33523352
- 💔 Bump `@mui/material` peer dependency for all packages (#11692) @LukasTy
@@ -3557,7 +3557,7 @@ Same changes as in `@mui/[email protected]`.
35573557
```
35583558

35593559
- The `useTreeItem` hook has been renamed `useTreeItemState`.
3560-
This will help create a new headless version of the `TreeItem` component based on a future `useTreeItem` hook.
3560+
This will help create a new headless version of the Tree Item component based on a future `useTreeItem` hook.
35613561

35623562
```diff
35633563
-import { TreeItem, useTreeItem } from '@mui/x-tree-view/TreeItem';
@@ -3657,13 +3657,13 @@ Same changes as in `@mui/[email protected]`.
36573657
- [docs] Cleanup and fix Pickers Playground styling (#11700) @LukasTy
36583658
- [docs] First draft of the Tree View custom plugin doc (#11564) @flaviendelangle
36593659
- [docs] Fix Pickers migration syntax and diffs (#11695) @LukasTy
3660-
- [docs] Fix generated tree view API docs (#11737) @LukasTy
3660+
- [docs] Fix generated Tree View API docs (#11737) @LukasTy
36613661
- [docs] Generate docs for Tree View slots (#11730) @flaviendelangle
36623662
- [docs] Improve codemod for v7 (#11650) @oliviertassinari
36633663
- [docs] Improve Data Grid `pageSizeOptions` prop documentation (#11682) @oliviertassinari
36643664
- [docs] Parse markdown on API docs demo titles (#11728) @LukasTy
36653665
- [docs] Remove the description from the `className` prop (#11693) @oliviertassinari
3666-
- [docs] Uplift `SimpleTreeView` customization examples (#11424) @noraleonte
3666+
- [docs] Uplift Simple Tree View customization examples (#11424) @noraleonte
36673667
- [docs] Uplift the Date Pickers playground (#11555) @danilo-leal
36683668

36693669
### Core
@@ -3740,8 +3740,8 @@ Same changes as in `@mui/[email protected]`.
37403740

37413741
### Tree View / `@mui/[email protected]`
37423742

3743-
- [tree view] Cleanup `onKeyDown` handler (#11481) @flaviendelangle
3744-
- [tree view] Define the parameters used by each plugin to avoid listing them in each component (#11473) @flaviendelangle
3743+
- [TreeView] Cleanup `onKeyDown` handler (#11481) @flaviendelangle
3744+
- [TreeView] Define the parameters used by each plugin to avoid listing them in each component (#11473) @flaviendelangle
37453745

37463746
### Docs
37473747

@@ -3768,7 +3768,7 @@ We'd like to offer a big thanks to the 7 contributors who made this release poss
37683768

37693769
- 🎁 New component to create a Tree View from a structured data source:
37703770

3771-
You can now directly pass your data to the `RichTreeView` component instead of manually converting it into JSX `TreeItem` components:
3771+
You can now directly pass your data to the `<RichTreeView />` component instead of manually converting it into JSX `<TreeItem />` components:
37723772

37733773
```tsx
37743774
const ITEMS = [
@@ -5099,7 +5099,7 @@ Here is an example of the renaming for the `<ChartsTooltip />` component.
50995099

51005100
### Core
51015101

5102-
- [core] Adds migration docs for charts, pickers and tree view (#10926) @michelengelen
5102+
- [core] Adds migration docs for Charts, Pickers, and Tree View (#10926) @michelengelen
51035103
- [core] Bump monorepo (#10959) @LukasTy
51045104
- [core] Changed prettier branch value to next (#10917) @michelengelen
51055105
- [core] Fix GitHub title tag consistency @oliviertassinari

changelogOld/CHANGELOG.v6.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1485,7 +1485,7 @@ Same changes as in `@mui/[email protected]`, plus:
14851485
- [docs] Fix charts demo using too deep import (#10263) @LukasTy
14861486
- [docs] Fix `e.g.` typo @oliviertassinari
14871487
- [docs] Fix npm package indentation @oliviertassinari
1488-
- [docs] Fix typo in tree view docs @oliviertassinari
1488+
- [docs] Fix typo in Tree View docs @oliviertassinari
14891489
- [docs] Improve the week picker example (#8257) @flaviendelangle
14901490
- [docs] Include code links in the Data Grid demo (#10219) @cherniavskii
14911491
- [docs] Polish page for SEO (#10216) @oliviertassinari
@@ -1546,7 +1546,7 @@ Same changes as in `@mui/[email protected]`.
15461546

15471547
- [docs] Add `DemoContainer` and `DemoItem` JSDoc (#10186) @LukasTy
15481548
- [docs] Add link to `custom layout` page (#10184) @LukasTy
1549-
- [docs] Add tree view nav item (#10181) @LukasTy
1549+
- [docs] Add Tree View nav item (#10181) @LukasTy
15501550
- [docs] Fix wrong chart tooltip reference (#10169) @oliviertassinari
15511551
- [docs] Improve chart SEO (#10170) @oliviertassinari
15521552
- [docs] Precise expired license key condition (#10165) @oliviertassinari
@@ -1748,7 +1748,7 @@ _Aug 4, 2023_
17481748

17491749
We'd like to offer a big thanks to the 12 contributors who made this release possible. Here are some highlights ✨:
17501750

1751-
- ⌚️ Move the tree view component from `@mui/lab` package
1751+
- ⌚️ Move the Tree View component from `@mui/lab` package
17521752

17531753
The `<TreeView />` component has been moved to the MUI X repository.
17541754
It is now accessible from its own package: `@mui/x-tree-view`.
@@ -1804,7 +1804,7 @@ Same changes as in `@mui/[email protected]`.
18041804
### Tree View / `@mui/[email protected]`
18051805

18061806
- [TreeView] Add missing exported types (#9862) @flaviendelangle
1807-
- [TreeView] Add tree view to changelog generator script (#9903) @MBilalShafi
1807+
- [TreeView] Add Tree View to changelog generator script (#9903) @MBilalShafi
18081808
- [TreeView] Create the package on the X repository (#9798) @flaviendelangle
18091809
- [TreeView] Improve props typing (#9855) @flaviendelangle
18101810

docs/data/common-concepts/custom-components/custom-components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This is the role of all the `baseXXX` component on the Data Grid component (`bas
1111
These slots receive props that should be as generic as possible so that it is easy to interface any other design system.
1212

1313
Other slots allow you to override parts of the MUI X UI components with a custom UI built specifically for this component.
14-
This is the role of slots like `calendarHeader` on the `DateCalendar` component or `item` on the `RichTreeView` component.
14+
This is the role of slots like `calendarHeader` on the `DateCalendar` component or `item` on the Rich Tree View component.
1515
These slots receive props specific to this part of the UI and will most likely not be re-use throughout your application.
1616

1717
## Basic usage

docs/data/migration/migration-tree-view-lab/migration-tree-view-lab.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ productId: x-tree-view
88

99
## Introduction
1010

11-
This is a reference for migrating your site's tree view from `@mui/lab` to `@mui/x-tree-view`.
11+
This is a reference for migrating your site's Tree View from `@mui/lab` to `@mui/x-tree-view`.
1212
This migration is about the npm packages used, it **does not** affect the behavior of the components in your application.
1313

1414
[//]: # 'You can find why we are moving in this direction in the [announcement blog post](/blog/lab-tree-view-to-mui-x/).'

0 commit comments

Comments
 (0)