forked from mantinedev/mantine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
61 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,31 @@ | ||
|  | ||
| # Mantine | ||
|
|
||
| Mantine is a customizable component library with focus on accessibility and developer experience. | ||
| Mantine is a MIT licensed open source react components and hooks library with focus on usability, accessibility and developer experience. | ||
|
|
||
| ## Links | ||
|
|
||
| - [Getting Started](https://mantine.dev/) | ||
| - [Documentation](https://mantine.dev/) | ||
| - [Examples](https://mantine.dev/pages/examples/) | ||
| - [Components by category](https://mantine.dev/core/getting-started/#components-by-category) | ||
| - [Hooks list](https://mantine.dev/hooks/getting-started/#included-hooks) | ||
| - [Notifications system](https://mantine.dev/others/notifications/) | ||
| - [Contributing](https://mantine.dev/pages/contribute/) | ||
|
|
||
| ## Installation | ||
|
|
||
| To start using Mantine you need to install [`@mantine/core`](https://www.npmjs.com/package/@mantine/core) and its peer dependencies: | ||
|
|
||
| ```sh | ||
| # With yarn | ||
| yarn add react-jss @mantine/theme @mantine/hooks @mantine/core | ||
|
|
||
| # With npm | ||
| npm install react-jss @mantine/theme @mantine/hooks @mantine/core | ||
|
|
||
| # With peerdeps | ||
| npx install-peerdeps @mantine/core | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Now you can import and use any component from @mantine/core: | ||
|
|
||
| ```tsx | ||
| import { Button } from '@mantine/core'; | ||
|
|
||
| function App() { | ||
| return <Button>Mantine button</Button>; | ||
| } | ||
| ``` | ||
| - [Ask question or give feedback](https://github.com/mantinedev/mantine/discussions) | ||
| - [Sign up for monthly newsletter](https://buttondown.email/mantine) | ||
| - [Follow Mantine on Twitter](https://twitter.com/mantinedev) | ||
|
|
||
| ## Features | ||
|
|
||
| - **Customization** – colors, fonts, shadows and many other parts are customizable to fit your design needs | ||
| - **Dark theme** – mantine supports dark theme by default in all components | ||
| - **Accessibility and usability** – all components follow accessibility best practices and feature full keyboard support | ||
| - **TypeScript** – all @mantine/ scoped packages are built with TypeScript and support it by default | ||
| - **Ready for production** – mantine is well tested and works in all modern browsers | ||
| - **Developer experience** – mantine comes with more than 50 components and 15 hooks to cover you in most cases | ||
| - **No annoying focus ring** – with new :focus-visible pseudo-class focus ring appears only when user navigates with keyboard | ||
| - **React JSS** – take advantage of all react-jss features: automatic critical css extraction during ssr, lazy evaluation, dynamic theming and others | ||
| - **React and Preact** – mantine works flawlessly with preact | ||
|
|
||
| ## Licence | ||
|
|
||
| All @mantine/ scoped packages, dependencies and peer dependencies have MIT licence. | ||
| All Mantine packages have MIT licence. All Mantine dependencies also have MIT licence, except react-transition-group package which has BSD-3-Clause license. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Mantine dates | ||
|
|
||
| This package is WIP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,24 @@ | ||
| # Mantine Notifications | ||
|
|
||
|  | ||
|
|
||
| Notifications system built on top of [Mantine](https://mantine.dev/) components library. | ||
|
|
||
| [Documentation](https://mantine.dev/others/notifications/) | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| # With yarn | ||
| yarn add @mantine/notifications @mantine/core @mantine/theme @mantine/hooks react-jss | ||
| yarn add @mantine/notifications @mantine/core @mantine/hooks react-jss | ||
|
|
||
| # With npm | ||
| yarn add @mantine/notifications @mantine/core @mantine/theme @mantine/hooks react-jss | ||
| yarn add @mantine/notifications @mantine/core @mantine/hooks react-jss | ||
|
|
||
| # With install-peerdeps | ||
| npx install-peerdeps @mantine/notifications | ||
| ``` | ||
|
|
||
| ## [Documentation and demos](https://mantine.dev/notifications/getting-started/) | ||
|
|
||
|  | ||
|
|
||
| ## Licence | ||
|
|
||
| All @mantine/ scoped packages, dependencies and peer dependencies have MIT licence. | ||
| All Mantine packages have MIT licence. All Mantine dependencies also have MIT licence, except react-transition-group package which has BSD-3-Clause license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters