UNPKG

@clerk/themes

Version:

Themes for the Clerk auth components

72 lines (46 loc) 3.18 kB
<p align="center"> <a href="https://clerk.com?utm_source=github&utm_medium=clerk_themes" target="_blank" rel="noopener noreferrer"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png"> <img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="64"> </picture> </a> <br /> <h1 align="center">@clerk/themes</h1> </p> <div align="center"> [![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord) [![Clerk documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs?utm_source=github&utm_medium=clerk_themes) [![Follow on Twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev) [Changelog](https://github.com/clerk/javascript/blob/main/packages/themes/CHANGELOG.md) · [Report a Bug](https://github.com/clerk/javascript/issues/new?assignees=&labels=needs-triage&projects=&template=BUG_REPORT.yml) · [Request a Feature](https://feedback.clerk.com/roadmap) · [Get help](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_themes) </div> ## Getting Started [Clerk](https://clerk.com/?utm_source=github&utm_medium=clerk_themes) is the easiest way to add authentication and user management to your application. Add sign up, sign in, and profile management to your application in minutes. You can customize the appearance of Clerk components by using the [appearance prop](https://clerk.com/docs/customization/overview?utm_source=github&utm_medium=clerk_themes). `@clerk/themes` offers prebuilt themes. ### Prerequisites - An existing Clerk application. [Create your account for free](https://dashboard.clerk.com/sign-up?utm_source=github&utm_medium=clerk_themes). ### Installation ```shell npm install @clerk/themes ``` ## Usage Learn how to [apply custom themes](https://clerk.com/docs/customization/themes#usage?utm_source=github&utm_medium=clerk_themes) in the reference documentation. ## Support You can get in touch with us in any of the following ways: - Join our official community [Discord server](https://clerk.com/discord) - On [our support page](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_themes) ## Contributing We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md). ## Security `@clerk/themes` follows good practices of security, but 100% security cannot be assured. `@clerk/themes` is provided **"as is"** without any **warranty**. Use at your own risk. _For more information and to report security issues, please refer to our [security documentation](https://github.com/clerk/javascript/blob/main/docs/SECURITY.md)._ ## License This project is licensed under the **MIT license**. See [LICENSE](https://github.com/clerk/javascript/blob/main/packages/themes/LICENSE) for more information.