Odyssey Design System

Build and design consistent, efficient, and accessible UIs for all Okta users.

Packages

Package/README	Description
@okta/odyssey-design-tokens	Design tokens
@okta/browserslist-config-odyssey	Browserslist config
@okta/odyssey-babel-preset	Babel preset
@okta/odyssey-react-mui	React MUI components

Browser Support

Odyssey browser support mirrors Okta's Supported platforms, browsers, and operating systems with the exception of IE 11.

Generating Okta Test Language files

For*_ok_PL.properties and *_ok_SK.properties you will need to download @okta/tools.i18n.pseudo-loc in the respective package directory (This will require access to our internal VPN).

Once that is downloaded you can run

yarn pseudo-loc generate --packageName ${absolutePathToPackage} --resourcePath ${pathToEnglishPropertiesFile} --bundle ${bundleName}

Example:

(from odyssey root)
cd packages/odyssey-react-mui
yarn add @okta/tools.i18n.pseudo-loc
yarn pseudo-loc generate --packageName ${OKTA_HOME}/odyssey/packages/odyssey-react-mui --resourcePath src/properties --bundle odyssey-react-mui

Note:

${OKTA_HOME} should contain an absolute path
You may need to specify the npmRegistryServer property explicitly in .yarnrc.yml with the internal yarn registry URL

Questions & Contributing

Please follow our Getting Started guide.

Running Odyssey locally

Follow these steps for local Odyssey development

License

Apache Version 2.0

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.

okta/odyssey