Skip to content

Commit

Permalink
[docs] Fix markdown table alignments (mui#7898)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Feb 14, 2023
1 parent 7af9705 commit 9503282
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 23 deletions.
8 changes: 4 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
The versions of the project that are currently supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 6.x | :white_check_mark: |
| 5.x | :white_check_mark: |
| < 5.0 | :x: |
| ------: | :----------------- |
| 6.x | :white_check_mark: |
| 5.x | :white_check_mark: |
| < 5.0 | :x: |

## Reporting a vulnerability

Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-grid/aggregation/aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ You can find full typing details on the [GridAggregationFunction API page](/x/ap
The `@mui/x-data-grid-premium` package comes with a set of built-in aggregation functions to cover the basic use cases:

| Name | Behavior | Supported column types |
| ------ | ---------------------------------------------------------- | ---------------------------- |
| :----- | :--------------------------------------------------------- | :--------------------------- |
| `sum` | Returns the sum of all values in the group | `number` |
| `avg` | Returns the non-rounded average of all values in the group | `number` |
| `min` | Returns the smallest value of the group | `number`, `date`, `dateTime` |
Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-grid/export/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Alternatively, you can set the `getRowsToExport` function and export any rows yo
The grid exports a few [selectors](/x/react-data-grid/state/#access-the-state) that can help you get the rows for the most common use-cases:

| Selector | Behavior |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| :--------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gridRowIdsSelector` | The rows in their original order. |
| `gridSortedRowIdsSelector` | The rows after applying the sorting rules. |
| `gridFilteredSortedRowIdsSelector` | The rows after applying the sorting rules, and the filtering rules. |
Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-grid/filtering/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Each column type comes with a default array of operators.
You can get them by importing the following functions:

| Column type | Function |
| -------------- | -------------------------------- |
| :------------- | :------------------------------- |
| `string` | `getGridStringOperators()` |
| `number` | `getGridNumericOperators()` |
| `boolean` | `getGridBooleanOperators()` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ In the example below, the action bar contains only one button, which resets the
The built-in `ActionBar` component supports four different actions:

| Action | Behavior |
| -------- | ---------------------------------------------------------------------- |
| :------- | :--------------------------------------------------------------------- |
| `accept` | Accept the current value and close the picker view |
| `cancel` | Reset to the last accepted date and close the picker view |
| `clear` | Reset to the empty value and close the picker view |
Expand Down
12 changes: 6 additions & 6 deletions docs/data/date-pickers/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ If you don't have your own requirements or don't manipulate dates outside of MUI

Here is the weight added to your gzipped bundle size by each of these libraries when used inside the Date and Time Pickers:

| **Library** | **Gzipped size** |
| ----------------- | ---------------- |
| `[email protected]` | 6.77kb |
| `[email protected]` | 19.39kb |
| `[email protected]` | 23.26kb |
| `[email protected]` | 20.78kb |
| Library | Gzipped size |
| :---------------- | -----------: |
| `[email protected]` | 6.77kB |
| `[email protected]` | 19.39kB |
| `[email protected]` | 23.26kB |
| `[email protected]` | 20.78kB |

:::info
The results above were obtained in October 2022 with the latest version of each library.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ To use the v5 version of MUI X, you first need to update to the new package name
- Some CSS classes were removed or renamed

| MUI X v4 classes | MUI X v5 classes |
| ---------------------------------- | ---------------------------------------- |
| :--------------------------------- | :--------------------------------------- |
| `.MuiDataGrid-window` | removed |
| `.MuiDataGrid-windowContainer` | removed |
| `.MuiDataGrid-viewport` | `.MuiDataGrid-virtualScroller` |
Expand Down Expand Up @@ -199,7 +199,7 @@ To use the v5 version of MUI X, you first need to update to the new package name
You can replace the following state access by their matching selectors:

| Direct state access | Selector |
| ----------------------- | ---------------------------------- |
| :---------------------- | :--------------------------------- |
| `state.rows` | `gridRowsStateSelector` |
| `state.filter` | `gridFilterStateSelector` |
| `state.sorting` | `gridSortingStateSelector` |
Expand Down Expand Up @@ -245,7 +245,7 @@ To use the v5 version of MUI X, you first need to update to the new package name
- Some selectors have been renamed to match with our naming convention:

| MUI X v4 selectors | MUI X v5 selectors |
| --------------------------------- | ------------------------------------- |
| :-------------------------------- | :------------------------------------ |
| `unorderedGridRowIdsSelector` | `gridRowIdsSelector` |
| `sortingGridStateSelector` | `gridSortingStateSelector` |
| `sortedGridRowIdsSelector` | `gridSortedRowIdsSelector` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The minimum supported Node.js version has been changed from 12.0.0 to 14.0.0, si
- To avoid confusion with the props that will be added for the cell selection feature, some props related to row selection were renamed to have "row" in their name. The renamed props are the following:

| Old name | New name |
| -------------------------- | ----------------------------- |
| :------------------------- | :---------------------------- |
| `selectionModel` | `rowSelectionModel` |
| `onSelectionModelChange` | `onRowSelectionModelChange` |
| `disableSelectionOnClick` | `disableRowSelectionOnClick` |
Expand Down Expand Up @@ -202,7 +202,7 @@ The minimum supported Node.js version has been changed from 12.0.0 to 14.0.0, si
- The column menu components have been renamed or merged with the new design for consistency and API improvement, the new components are following:

| Old name | New name |
| ------------------------------------------------------------------- | ------------------------------- |
| :------------------------------------------------------------------ | :------------------------------ |
| `GridFilterMenuItem` | `GridColumnMenuFilterItem` |
| `HideGridColMenuItem` | `GridColumnMenuHideItem` |
| `GridColumnsMenuItem` | `GridColumnMenuColumnsItem` |
Expand Down Expand Up @@ -271,7 +271,7 @@ Most of this breaking change is handled by `preset-safe` codemod but some furthe
<summary markdown="span">List of removed undocumented methods and properties</summary>

| |
| ------------------------------------------------- |
| :------------------------------------------------ |
| `getLogger` |
| `windowRef` |
| `footerRef` |
Expand Down Expand Up @@ -386,7 +386,7 @@ Most of this breaking change is handled by `preset-safe` codemod but some furthe
- Some CSS classes were removed or renamed

| MUI X v5 classes | MUI X v6 classes | Note |
| ------------------------------------------ | ------------------------------------------- | ----------------------------------------------- |
| :----------------------------------------- | :------------------------------------------ | :---------------------------------------------- |
| `.MuiDataGrid-withBorder` | `.MuiDataGrid-withBorderColor` | The class only sets `border-color` CSS property |
| `.MuiDataGrid-filterFormLinkOperatorInput` | `.MuiDataGrid-filterFormLogicOperatorInput` | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ Works exactly the same way for `PickersMonth`
The props used to set the text displayed in the pickers have been replaced by keys inside the `localeText` prop:

| Removed prop | Property in the new `localText` prop |
| ---------------------------- | --------------------------------------------------------------------------------- |
| :--------------------------- | :-------------------------------------------------------------------------------- |
| `endText` | `end` |
| `getClockLabelText` | `clockLabelText` |
| `getHoursClockNumberText` | `hoursClockNumberText` |
Expand Down Expand Up @@ -714,7 +714,7 @@ For example, the `ToolbarComponent` has been replaced by a `Toolbar` component s
```diff
+import { usePickerLayout } from '@mui/x-date-pickers/PickersLayout';

function MyCustomLayout (props) {
function MyCustomLayout(props) {
- const { children } = props;
-
- return (
Expand Down

0 comments on commit 9503282

Please sign in to comment.