Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs][data grid] Add documentation for the list view feature #15344

Merged
merged 27 commits into from
Nov 27, 2024

Conversation

KenanYusuf
Copy link
Member

@KenanYusuf KenanYusuf commented Nov 8, 2024

Closes #14996
Closes #6460

@KenanYusuf KenanYusuf added docs Improvements or additions to the documentation component: data grid This is the name of the generic UI component, not the React module! feature: List view Related to the data grid liist view feature labels Nov 8, 2024
@mui-bot
Copy link

mui-bot commented Nov 8, 2024

Deploy preview: https://deploy-preview-15344--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against 0298aea

@mnajdova
Copy link
Member

You need to apply these changes in the formattedTSDemos:

index 51eb1f82e..322d1c78f 100644
--- a/docs/scripts/formattedTSDemos.js
+++ b/docs/scripts/formattedTSDemos.js
@@ -9,7 +9,7 @@
  * List of demos to ignore when transpiling
  * Example: "app-bar/BottomAppBar.tsx"
  */
-const ignoreList = ['/pages.ts', 'styling.ts', 'styling.tsx'];
-const ignoreList = ['/pages.ts', 'styling.ts', 'styling.tsx'];
+const ignoreList = ['/pages.ts', 'styling.ts', 'styling.tsx', 'types.ts'];
 
 const fs = require('fs');
 const fse = require('fs-extra');
@@ -55,7 +55,8 @@ async function getFiles(root) {
           files.push(...(await getFiles(filePath)));
         } else if (
           stat.isFile() &&
-          filePath.endsWith('.tsx') &&
+          /\.tsx?$/.test(filePath) &&
+          !filePath.endsWith('.d.ts') &&
           !ignoreList.some((ignorePath) => filePath.endsWith(path.normalize(ignorePath)))
         ) {
           files.push(filePath);
@@ -79,7 +80,7 @@ const TranspileResult = {
 };
 
 async function transpileFile(tsxPath, program, ignoreCache = false) {
-  const jsPath = tsxPath.replace('.tsx', '.js');
+  const jsPath = tsxPath.replace('.tsx', '.js').replace('.ts', '.js');
   try {
     if (!ignoreCache && (await fse.exists(jsPath))) {
:

I tried this locally, but it transpiles more files, can you double check if this is expected? We may need to add more items in the ignoreList

@KenanYusuf
Copy link
Member Author

Thanks @mnajdova - I've made these changes over in #15345 to avoid polluting this PR.

Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 20, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 21, 2024
@KenanYusuf KenanYusuf marked this pull request as ready for review November 21, 2024 10:33
@KenanYusuf KenanYusuf requested review from samuelsycamore and a team November 21, 2024 13:11
docs/data/data-grid/list-view/list-view.md Outdated Show resolved Hide resolved
docs/data/data-grid/list-view/list-view.md Outdated Show resolved Hide resolved
docs/data/data-grid/list-view/list-view.md Outdated Show resolved Hide resolved
docs/data/data-grid/list-view/list-view.md Outdated Show resolved Hide resolved
docs/data/data-grid/list-view/list-view.md Outdated Show resolved Hide resolved
KenanYusuf and others added 2 commits November 22, 2024 09:07
Co-authored-by: Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Kenan Yusuf <kenan.m.yusuf@gmail.com>
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 22, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@KenanYusuf
Copy link
Member Author

@samuelsycamore thanks for the review! I made a few more changes to the column definition prop descriptions, would you mind taking another look? 🙏 https://github.com/mui/mui-x/pull/15344/files#diff-e6ca07fd0bb0e954721c94acb249fb8c021cc559155fa0496b331cc20bff1802

Signed-off-by: Kenan Yusuf <kenan.m.yusuf@gmail.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 22, 2024
Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing! Massive improvement @KenanYusuf !

Copy link
Member

@cherniavskii cherniavskii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!
I've pushed just 2 minor commits: 32e92a0 (#15344), 6356ab4 (#15344)

@KenanYusuf KenanYusuf merged commit 2e05222 into mui:master Nov 27, 2024
18 checks passed
@KenanYusuf KenanYusuf deleted the list-view-docs branch November 27, 2024 14:58
KenanYusuf added a commit to KenanYusuf/mui-x that referenced this pull request Nov 27, 2024
)

Signed-off-by: Kenan Yusuf <kenan.m.yusuf@gmail.com>
Co-authored-by: Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Bilal Shafi <bilalshafidev@gmail.com>
Co-authored-by: Andrew Cherniavskyi <andrew@mui.com>
KenanYusuf added a commit that referenced this pull request Nov 27, 2024
#15635)

Signed-off-by: Kenan Yusuf <kenan.m.yusuf@gmail.com>
Co-authored-by: Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Bilal Shafi <bilalshafidev@gmail.com>
Co-authored-by: Andrew Cherniavskyi <andrew@mui.com>
LukasTy pushed a commit to LukasTy/mui-x that referenced this pull request Dec 19, 2024
)

Signed-off-by: Kenan Yusuf <kenan.m.yusuf@gmail.com>
Co-authored-by: Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Bilal Shafi <bilalshafidev@gmail.com>
Co-authored-by: Andrew Cherniavskyi <andrew@mui.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation feature: List view Related to the data grid liist view feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[data grid] Improve list view documentation [data grid] Mobile responsiveness support for DataGrid
6 participants