{"id":16208144,"url":"https://github.com/verdan/material-ui-package","last_synced_at":"2025-04-07T20:23:58.250Z","repository":{"id":72984091,"uuid":"81241977","full_name":"verdan/material-ui-package","owner":"verdan","description":null,"archived":false,"fork":false,"pushed_at":"2017-02-07T18:50:19.000Z","size":588,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-13T21:49:38.109Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/verdan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2017-02-07T18:49:01.000Z","updated_at":"2017-02-07T18:49:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"b80c45dd-a9a9-4802-9964-9a741a4dd673","html_url":"https://github.com/verdan/material-ui-package","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fmaterial-ui-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fmaterial-ui-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fmaterial-ui-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fmaterial-ui-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/verdan","download_url":"https://codeload.github.com/verdan/material-ui-package/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247722723,"owners_count":20985238,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-10T10:15:32.154Z","updated_at":"2025-04-07T20:23:58.206Z","avatar_url":"https://github.com/verdan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#### Note\n\nFor *how-to* questions and other non-issues,\nplease use [StackOverflow](http://stackoverflow.com/questions/tagged/material-ui)\ninstead of Github issues. There is a StackOverflow tag called \"material-ui\"\nthat you can use to tag your questions.\n\n#[Material-UI](http://www.material-ui.com/)\n[![npm package](https://img.shields.io/npm/v/material-ui.svg?style=flat-square)](https://www.npmjs.org/package/material-ui)\n[![Build Status](https://travis-ci.org/callemall/material-ui.svg?branch=master)](https://travis-ci.org/callemall/material-ui)\n[![Gitter](https://img.shields.io/badge/gitter-join%20chat-f81a65.svg?style=flat-square)](https://gitter.im/callemall/material-ui?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Coverage Status](https://coveralls.io/repos/github/callemall/material-ui/badge.svg?branch=master)](https://coveralls.io/github/callemall/material-ui?branch=master)\n\n[![PeerDependencies](https://img.shields.io/david/peer/callemall/material-ui.svg?style=flat-square)](https://david-dm.org/callemall/material-ui#info=peerDependencies\u0026view=list)\n[![Dependencies](https://img.shields.io/david/callemall/material-ui.svg?style=flat-square)](https://david-dm.org/callemall/material-ui)\n[![DevDependencies](https://img.shields.io/david/dev/callemall/material-ui.svg?style=flat-square)](https://david-dm.org/callemall/material-ui#info=devDependencies\u0026view=list)\n\nMaterial-UI is a set of [React](http://facebook.github.io/react/) components that implement\n[Google's Material Design](https://www.google.com/design/spec/material-design/introduction.html)\nspecification.\n\nCheck out our [documentation site](http://www.material-ui.com/) for live examples.\nIt's still a work in progress, but hopefully you can see where we're headed.\n\n**Recently Updated?** Please read the [changelog](https://github.com/callemall/material-ui/releases), this README and the documentation before posting an issue.\n\n## Required Knowledge\n\nWe recommend that you get to know [React](http://facebook.github.io/react/)\nbefore diving into material-ui. Material-UI is a set of React components,\nso understanding how React fits into web development is important.\n\n(If you're not familiar with Node, or with the concept of Single Page Applications (SPAs),\nhead over to the [documentation website](http://material-ui.com/#/get-started/required-knowledge)\nfor a quick introduction before you read on.)\n\n## Installation\n\nMaterial-UI is available as an [npm package](https://www.npmjs.org/package/material-ui).\n\n**Stable channel**\n```sh\nnpm install material-ui\n```\n\n**Pre-release channel**\n```sh\nnpm install material-ui@next\n```\n\nPlease note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.\n\n\n### React-Tap-Event-Plugin\n\nSome components use\n[react-tap-event-plugin](https://github.com/zilverline/react-tap-event-plugin) to\nlisten for touch events because onClick is not fast enough\n_This dependency is temporary and will eventually go away._ Until then,\nbe sure to inject this plugin at the start of your app.\n\n```js\nimport injectTapEventPlugin from 'react-tap-event-plugin';\n\n// Needed for onTouchTap\n// http://stackoverflow.com/a/34015469/988941\ninjectTapEventPlugin();\n```\n\n### Roboto Font\n\nMaterial-UI was designed with the [Roboto](http://www.google.com/fonts/specimen/Roboto)\nfont in mind. So be sure to include it in your project. Here are\n[some instructions](http://www.google.com/fonts#UsePlace:use/Collection:Roboto:400,300,500)\non how to do so.\n\n## Usage\n\nBeginning with v0.15.0, Material-UI components require a theme to be provided. The quickest way to get up and running is by using the `MuiThemeProvider` to inject the theme into your application context. Following that, you can use any of the components as demonstrated in the documentation.\n\nHere is a quick example to get you started:\n\n**./App.js**\n```jsx\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport MuiThemeProvider from 'material-ui/styles/MuiThemeProvider';\nimport MyAwesomeReactComponent from './MyAwesomeReactComponent';\n\nconst App = () =\u003e (\n  \u003cMuiThemeProvider\u003e\n    \u003cMyAwesomeReactComponent /\u003e\n  \u003c/MuiThemeProvider\u003e\n);\n\nReactDOM.render(\n  \u003cApp /\u003e,\n  document.getElementById('app')\n);\n```\n\n**./MyAwesomeReactComponent.js**\n```jsx\nimport React from 'react';\nimport RaisedButton from 'material-ui/RaisedButton';\n\nconst MyAwesomeReactComponent = () =\u003e (\n  \u003cRaisedButton label=\"Default\" /\u003e\n);\n\nexport default MyAwesomeReactComponent;\n```\n\nPlease refer to each component's documentation page to see how they should be imported.\n\n## Customization\n\nWe have implemented a default theme to render all Material-UI components.\nStyling components to your liking is simple and hassle-free. This can be\nachieved in the following two ways:\n\n* [Use a custom theme to style components](http://material-ui.com/#/customization/themes)\n* [Override individual component styles via the `style` prop](http://www.material-ui.com/#/customization/styles)\n\n## Examples\n\nThere are 2 projects that you can look at to get started. They can be found in the\n[examples folder](https://github.com/callemall/material-ui/tree/master/examples).\nThese projects are basic examples that show how to consume material-ui components\nin your own project. The first project uses [browserify](http://browserify.org/)\nfor module bundling and [gulp](http://gulpjs.com/) for JS task automation,\nwhile the second project uses [webpack](http://webpack.github.io/) for module bundling and building.\n\nThe source code for this documentation site is also included in the repository.\nThis is a slightly more complex project that also uses webpack, and contains\nexamples of every material-ui component. Check out the\n[docs folder](https://github.com/callemall/material-ui/tree/master/docs)\nfor build instructions.\n\n## Roadmap\n\nThe future plans and high priority features and enhancements can be found\nin the [ROADMAP.md](https://github.com/callemall/material-ui/blob/master/ROADMAP.md) file.\n\n## Contribute\n\n[Material-UI](http://www.material-ui.com/) came about from our love of\n[React](http://facebook.github.io/react/) and\n[Google's Material Design](https://www.google.com/design/spec/material-design/introduction.html).\nWe're currently using it on a project at [Call-Em-All](https://www.call-em-all.com/Careers)\nand plan on adding to it and making it better. If you'd like to help,\ncheck out the [docs folder](https://github.com/callemall/material-ui/tree/master/docs).\nWe'd greatly appreciate any [contribution](https://github.com/callemall/material-ui/blob/master/CONTRIBUTING.md)\nyou make. :)\n\n## Thanks\n\n[\u003cimg src=\"https://www.browserstack.com/images/mail/browserstack-logo-footer.png\" width=\"120\"\u003e](https://www.browserstack.com/)\n\nThank you to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test `material-ui` in real browsers.\n\n## License\nThis project is licensed under the terms of the\n[MIT license](https://github.com/callemall/material-ui/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdan%2Fmaterial-ui-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fverdan%2Fmaterial-ui-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdan%2Fmaterial-ui-package/lists"}