@materializecss/materialize
v2.2.1
Published
The responsive front-end library based on Material Design from Google.
Downloads
11,432
Readme
Getting started
Read the getting started guide for more information on how to use materialize.
- Download the latest release of materialize directly from GitHub. (Beta)
- Clone the repo:
git clone https://github.com/materializecss/materialize.git
- Include the files via jsDelivr.
- Install with npm:
npm install @materializecss/materialize
(Beta:npm install @materializecss/materialize@next
)
Testing
To run tests locally you first have to build the files and then run the tests. This can be done with the command npm test
;
To get more info and debug information you can do the following:
run npx jasmine-browser-runner
then go to the url via browser http://localhost:8888
. The tests will then run and show detailed feedback.
Development
The documentation can be found at https://materializeweb.com. To run the documentation locally on your machine, you need Node.js installed on your computer. This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation.
Running documentation locally
See Materialize Docs Repo to see Materialize in Action.
Releases
Previous releases are available here.
Supported Browsers:
Materialize is compatible with:
- Chrome 35+
- Firefox 31+
- Safari 9+
- Opera
- Edge
Changelog
For changelogs, check out the Releases section of materialize or the CHANGELOG.md.
Testing
We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, here's a starting guide on how to write tests in Jasmine.
Contributing
Check out the CONTRIBUTING document in the root of the repository to learn how you can contribute. You can also browse the help-wanted tag in our issue tracker to find things to do.
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Backers
Thank you to all our backers! 🙏 [Become a backer]
Copyright and license
Code Copyright 2024 Materialize. Code released under the MIT license.