{"id":13398465,"url":"https://github.com/mlaursen/react-md","last_synced_at":"2026-05-02T02:08:49.102Z","repository":{"id":5661520,"uuid":"46743486","full_name":"mlaursen/react-md","owner":"mlaursen","description":"React material design - An accessible React component library built from the Material Design guidelines in Sass","archived":false,"fork":false,"pushed_at":"2026-04-12T14:18:47.000Z","size":88168,"stargazers_count":2330,"open_issues_count":18,"forks_count":294,"subscribers_count":51,"default_branch":"main","last_synced_at":"2026-04-17T03:13:42.374Z","etag":null,"topics":["accessibility","component-library","components","material","material-components","material-design","react","react-md","scss","typescript"],"latest_commit_sha":null,"homepage":"https://react-md.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlaursen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG-v5.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"open_collective":"react-md"}},"created_at":"2015-11-23T19:39:04.000Z","updated_at":"2026-04-12T14:18:52.000Z","dependencies_parsed_at":"2024-01-14T04:41:48.202Z","dependency_job_id":"8dc00e42-da80-4b60-a848-6cc0c8322b1b","html_url":"https://github.com/mlaursen/react-md","commit_stats":{"total_commits":4966,"total_committers":84,"mean_commits":59.11904761904762,"dds":0.07450664518727346,"last_synced_commit":"292cebf72f7c3caa3e07542b0c7945a290666030"},"previous_names":[],"tags_count":333,"template":false,"template_full_name":null,"purl":"pkg:github/mlaursen/react-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlaursen%2Freact-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlaursen%2Freact-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlaursen%2Freact-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlaursen%2Freact-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlaursen","download_url":"https://codeload.github.com/mlaursen/react-md/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlaursen%2Freact-md/sbom","scorecard":{"id":653186,"data":{"date":"2025-08-11","repo":{"name":"github.com/mlaursen/react-md","commit":"9b93fa7366f53c7f1e68bb8d4ad287edf2a96b59"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'packages' permission set to 'read': .github/workflows/codeql-analysis.yml:36","Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:39","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:40","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/label.yml:1","Warn: no topLevel permission defined: .github/workflows/main.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":10,"reason":"SAST tool detected: CodeQL","details":["Info: SAST configuration detected: CodeQL","Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/label.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/mlaursen/react-md/main.yml/main?enable=pin","Warn: containerImage not pinned by hash: examples/react-router-framework-mode/Dockerfile:1","Warn: containerImage not pinned by hash: examples/react-router-framework-mode/Dockerfile:6","Warn: containerImage not pinned by hash: examples/react-router-framework-mode/Dockerfile:11","Warn: containerImage not pinned by hash: examples/react-router-framework-mode/Dockerfile:17: pin your Docker image by updating node:20-alpine to node:20-alpine@sha256:df02558528d3d3d0d621f112e232611aecfee7cbc654f6b375765f72bb262799","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned","Info:   0 out of   4 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":0,"reason":"18 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m","Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-7m27-7ghc-44w9","Warn: Project is vulnerable to: GHSA-qpjv-v59x-3qc4","Warn: Project is vulnerable to: GHSA-f82v-jwr5-mffw","Warn: Project is vulnerable to: GHSA-3h52-269p-cp9r","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T14:00:16.115Z","repository_id":5661520,"created_at":"2025-08-21T14:00:16.115Z","updated_at":"2025-08-21T14:00:16.115Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32445556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T20:22:27.477Z","status":"ssl_error","status_checked_at":"2026-04-29T20:22:26.507Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","component-library","components","material","material-components","material-design","react","react-md","scss","typescript"],"created_at":"2024-07-30T19:00:26.851Z","updated_at":"2026-04-29T22:03:34.404Z","avatar_url":"https://github.com/mlaursen.png","language":"TypeScript","funding_links":["https://opencollective.com/react-md","https://paypal.me/mlaursen03"],"categories":["JavaScript","React","TypeScript","组件库相关","UI Components"],"sub_categories":["Frameworks","React"],"readme":"# react-md [![license](https://img.shields.io/npm/l/react-md)](https://github.com/mlaursen/react-md/blob/main/LICENSE) [![codecov](https://codecov.io/gh/mlaursen/react-md/branch/main/graph/badge.svg)](https://codecov.io/gh/mlaursen/react-md) [![Actions Status](https://github.com/mlaursen/react-md/workflows/Build,%20Lint,%20and%20Test/badge.svg)](https://github.com/mlaursen/react-md/actions)\n\n[![npm](https://img.shields.io/npm/v/react-md)](https://www.npmjs.com/package/react-md)\n[![downloads](https://img.shields.io/npm/dw/react-md)](https://www.npmjs.com/package/react-md)\n[![Join the Chat at Slack](https://react-md.herokuapp.com/badge.svg)](https://react-md.herokuapp.com)\n[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/mlaursen03)\n\nCreate an accessible React application with the\n[material design specifications](https://material.io/design/) and Scss.\n\n- [Installing packages](https://react-md.dev/guides/installation) - How to\n  install related components and packages within react-md for building your\n  application\n- [Creating a new app](https://react-md.dev/guides/creating-a-new-app) - How to\n  create a new app with react-md\n- [Using a GitHub template](https://github.com/mlaursen/template-rmd) - Create a\n  new repo from a GitHub template including reasonable react-md defaults and\n  Next.js.\n- [Examples with Build Tools](./examples) - View and download examples of using\n  ReactMD with build tools such as [create-react-app], [Next.js], and [Gatsby]\n- [Customizing your theme](https://react-md.dev/guides/customizing-your-theme) -\n  How to implement a different theme for your React application\n- [Full documentation](https://react-md.dev) - All the remaining documentation\n  along with every single guide, API Reference, and examples\n- [Library Size](#library-size) - The UMD bundle size for the entire `react-md`\n  library and sizes for some of the pre-built css files.\n\n\u003c!-- rmd-readme-replace --\u003e\n\n### Highlights/Features\n\n- Matches the accessibility guidelines from\n  [www.w3.org](https://www.w3.org/TR/wai-aria-practices)\n- Low level customizable components\n- Easily themeable on a global and component level\n- Uses css variables for dynamic themes with fallbacks for older browsers\n- Out of the box dark theme mode support\n- Out of the box left-to-right and right-to-left language support\n- UMD Bundles and pre-compiled css available on https://unpkg.com (see more\n  information [here](https://react-md.dev/guides/cdn-links))\n- Written and maintained in [Typescript]\n\n## Creating a new project\n\n\u003e Check out the [examples folder](./examples) to see completed examples with\n\u003e different build tools such as [Next.js], [Gatsby], and [create-react-app].\n\nFirst use [create-react-app] to create your project:\n\n```sh\nnpx create-react-app my-app\ncd my-app\nnpm start\n```\n\n\u003e npx comes with npm 5.2+ and higher, if you have an older version you will need\n\u003e to install `create-react-app` globally instead\n\nOr with `yarn`:\n\n```sh\nyarn create react-app my-app\ncd my-app\n```\n\n\u003e NOTE: You can also add the `--typescript` flag to bootstrap a react-app with\n\u003e typescript support\n\nNext, install `react-md` and `sass`:\n\n```sh\nnpm install --save react-md sass\n```\n\nNext, create a `src/App.scss` file to include all the `react-md` styles and\nimport the `App.scss` file in the `src/App.js`:\n\n```scss\n@use \"react-md\" as *;\n\n// this will include all the styles from react-md\n@include react-md-utils;\n```\n\n```diff\n+import './App.scss';\n import logo from './logo.svg';\n import './App.css';\n```\n\nFinally, update the `public/index.html` to include the `Roboto` font and the\nMaterial Icons font icons stylesheets from Google fonts:\n\n```diff\n     \u003cmeta charset=\"utf-8\" /\u003e\n     \u003clink rel=\"shortcut icon\" href=\"%PUBLIC_URL%/favicon.ico\" /\u003e\n     \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /\u003e\n     \u003cmeta name=\"theme-color\" content=\"#000000\" /\u003e\n     \u003c!--\n       manifest.json provides metadata used when your web app is installed on a\n       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/\n     --\u003e\n     \u003clink rel=\"manifest\" href=\"%PUBLIC_URL%/manifest.json\" /\u003e\n+    \u003clink rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Roboto:300,400,500,700|Material+Icons\"\u003e\n     \u003c!--\n       Notice the use of %PUBLIC_URL% in the tags above.\n       It will be replaced with the URL of the `public` folder during the build.\n       Only files inside the `public` folder can be referenced from the HTML.\n\n       Unlike \"/favicon.ico\" or \"favicon.ico\", \"%PUBLIC_URL%/favicon.ico\" will\n       work correctly both with client-side routing and a non-root public URL.\n       Learn how to configure a non-root public URL by running `npm run build`.\n     --\u003e\n     \u003ctitle\u003eReact App\u003c/title\u003e\n   \u003c/head\u003e\n-  \u003cbody\u003e\n+  \u003cbody class=\"rmd-typography\"\u003e\n```\n\nOnce you have the styles, fonts, and font icons setup, you can start creating\ncomponents from react-md. It is generally recommended to update your base\n`src/App.js` to include some default configuration components:\n\n```diff\n import './App.scss';\n-import logo from './logo.svg';\n-import './App.css';\n-\n-function App() {\n-  return (\n-    \u003cdiv className=\"App\"\u003e\n-      \u003cheader className=\"App-header\"\u003e\n-        \u003cimg src={logo} className=\"App-logo\" alt=\"logo\" /\u003e\n-        \u003cp\u003e\n-          Edit \u003ccode\u003esrc/App.js\u003c/code\u003e and save to reload.\n-        \u003c/p\u003e\n-        \u003ca\n-          className=\"App-link\"\n-          href=\"https://reactjs.org\"\n-          target=\"_blank\"\n-          rel=\"noopener noreferrer\"\u003e\n-          Learn React\n-        \u003c/a\u003e\n-      \u003c/header\u003e\n-    \u003c/div\u003e\n-  );\n-}\n+import {\n+  Configuration,\n+  Layout,\n+  useLayoutNavigation,\n+  Typography,\n+  Button,\n+} from 'react-md';\n+\n+// see @react-md/layout package for info on the main navigation\n+const routes = {};\n+function App() {\n+  return (\n+    \u003cConfiguration\u003e\n+      \u003cLayout\n+        title=\"My Title\"\n+        navHeaderTitle=\"My Nav Title\"\n+        treeProps={...useLayoutNavigation(routes, pathname)}\n+      \u003e\n+        \u003cTypography type=\"headline-4\"\u003eHello, world!\u003c/Typography\u003e\n+        \u003cButton theme=\"primary\"\u003eExample button\u003c/Button\u003e\n+      \u003c/Layout\u003e\n+    \u003c/Configuration\u003e\n+  );\n+}\n\nexport default App;\n```\n\nMore information can be found on the documentation site's page\n[about creating projects](https://react-md.dev/guides/installation)\n\n## Library Size\n\nThe base `react-md` package (non-scoped) is the only package that also provides\npre-built css themes and a UMD bundle. If you are interested in seeing what an\nestimated size for this library, check out the results below:\n\n```sh\nyarn dev-utils libsize\n\nThe gzipped UMD bundle sizes are:\n - dist/umd/react-md.production.min.js 92.51 kB\n - dist/umd/react-md-with-font-icons.production.min.js 211.46 kB\n - dist/umd/react-md-with-svg-icons.production.min.js 211.5 kB\n\nThe min and max gzipped CSS bundle sizes are:\n - themes/react-md.grey-red-700-light.min.css 18.08 kB\n - themes/react-md.lime-teal-200-dark.min.css 18.15 kB\n```\n\n## Contributing\n\nPlease read the [contributing guidelines](./.github/CONTRIBUTING.md) if you\nwould like to contribute.\n\n[typescript]: https://www.typescriptlang.org/\n[next.js]: https://nextjs.org/\n[gatsby]: https://www.gatsbyjs.org\n[create-react-app]: https://facebook.github.io/create-react-app\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlaursen%2Freact-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlaursen%2Freact-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlaursen%2Freact-md/lists"}