materializecss/materialize: Materialize, a web framework based on Material Design · GitHub

Name		Name	Last commit message	Last commit date
.github		.github
.storybook		.storybook
components		components
dist		dist
docs		docs
sass		sass
spec		spec
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
compress.mjs		compress.mjs
empty.js		empty.js
eslint.config.mjs		eslint.config.mjs
index.html		index.html
jasmine.json		jasmine.json
package-lock.json		package-lock.json
package.json		package.json
rollup.config.ts		rollup.config.ts
tsconfig.json		tsconfig.json

Repository files navigation

Materialize

Materialize, a CSS Framework based on Material Design.
[ Browse the docs ]

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. You can also find the changelog under each release.

Supported Browsers:

Materialize is compatible with:

Chrome 35+
Firefox 31+
Safari 9+
Opera
Edge

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.

Quick Testing and Development

For quick testing install live-server node package globally and run npm run demo

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.