@okta/odyssey-react-theme
Production Readiness
This project has not yet hit version 1.0.0 and is still in active development.
That said, it is beyond the early alpha stage in some key areas. For some early-adopters that means it is good enough to use for real things. Some other people think this means it is not ready yet.
Even though the project is in development, effort is still made to keep the API stable. Patch versions are intended for backwards-compatible changes and minor versions are intended for backwards-incompatible changes.
If you plan to use this for something real, you should either pin the exact version (maximum safety) or pin the major and minor versions (only accept backwards-compatible upgrades).
Getting Started
Install the package:
$ yarn add @okta/odyssey-react-theme
Import named ESM exports:
import { ThemeProvider } from "@okta/odyssey-react-theme";
To access the current theme values use our hook:
import { useTheme } from "@okta/odyssey-react-theme";
Components
Components are published in an ESM format transpiled for the modern browsers within the Okta supported browser list. These modules can be served directly to evergreen browsers for simple applications, or further transpiled, bundled, and polyfilled for advanced use cases and browser support targets.
License
Support Disclaimer
This library is community supported and is maintained by members of the Okta team for developers and IT professionals. This library is not an official Okta product and does not qualify for any Okta support. Anyone who chooses to use this library must ensure that their implementation meets any applicable legal obligations including any Okta terms and conditions.