open-index/open-npm huggingface dataset:
npm package: @okta/odyssey
Description: Okta's design system
Author: Okta, Inc.
Latest version: 0.7.0

# @okta/odyssey

This package provides the necessary SCSS and fonts to utilize Odyssey, Okta's design system.

For guidance on how and when to implement individual components, please see our <a href="https://design-docs.trexcloud.com/">online docs</a>.

## What's included

`dist/odyssey.css` - A precompiled version of Odyssey for those who don't need the benefits of Sass.

`src/scss` - The SCSS source files for Odyssey, ready to be `@import`'d into your project.

`src/scss/odyssey.scss` - The main compilation sheet for Odyssey.

## Getting started

### Install Odyssey

Using yarn:

`$ yarn add @okta/odyssey`

If you prefer npm, use the following command instead:

`$ npm install --save @okta/odyssey`

### SCSS

Usage of the Odyssey Sass files assumes the use of a SCSS pre-processor. All Sass files use the `*.scss` file extension and syntax.

#### Autoprefixer

Make sure your asset pipeline utilizes <a href="https://github.com/postcss/autoprefixer">autoprefixer</a> to ensure vendor prefixes are automatically added to your compiled CSS.

#### Importing SCSS files

To add a Odyssey to your build, import the compilation sheet directly.

```scss
@import 'node_modules/odyssey/src/scss/odyssey';
```

This will import all functions, mixins, abstracts, components, and layouts into your build.

If you are looking for a more limited selection, you can also import select components, etc individually.

## Contributing

### Linting

Odyssey utilizes <a href="https://stylelint.io/">stylelint</a> for our live linting as well as our lint tests.

You can check the current syntax rule configuration in `stylelint.json`.
npm package: @okta/odyssey-babel-loader
Description: Babel webpack loader for Odyssey, Okta's design system
Author: Okta, Inc.
Latest version: 1.22.0

# @okta/odyssey-babel-loader

## 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:

```sh
$ yarn add --dev @okta/odyssey-babel-loader
```

Reference the loader within your webpack configuration:

```js
module.exports = {
  module: {
    rules: [
      {
        test: /\.(js|jsx|ts|tsx)$/,
        exclude: /node_modules/,
        use: {
          loader: "@okta/odssey-babel-loader",
        },
      },
    ],
  },
};
```

All of the [configuration options][1] available to `babel-loader` are available
here as well. Additionally, an `include` option accepts an array of regular
expressions or escaped regular expression strings to target style modules
that may be using unconventional file extensions.

[1]: https://github.com/babel/babel-loader

## License

[Apache Version 2.0](https://github.com/okta/odyssey/blob/main/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.
npm package: @okta/odyssey-babel-plugin
Description: Babel plugin for Odyssey, Okta's design system
Author: Okta, Inc.
Latest version: 0.15.3

# @okta/odyssey-babel-plugin

## 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:

```sh
$ yarn add --dev @okta/odyssey-babel-plugin
```

Reference the plugin within your babel configuration:

```js
module.exports = {
  plugins: [
    [
      "@okta/odyssey-babel-plugin",
      {
        identityObjectProxy: true,
      },
    ],
  ],

  env: {
    production: {
      plugins: ["@okta/odyssey-babel-plugin"],
    },
  },
};
```

## License

[Apache Version 2.0](https://github.com/okta/odyssey/blob/master/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.
npm package: @okta/odyssey-babel-preset
Description: Babel preset for Odyssey, Okta's design system
Author: Okta, Inc.
Latest version: 1.30.0

# @okta/odyssey-babel-preset

## 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:

```sh
$ yarn add --dev @okta/odyssey-babel-preset
```

Reference the preset within your babel configuration:

```js
module.exports = {
  presets: [
    [
      "@okta/odyssey-babel-preset",
      {
        odyssey: {
          identityObjectProxy: true,
        },
        react: {
          runtime: "classic",
        },
      },
    ],
  ],

  env: {
    production: {
      presets: [
        [
          "@okta/odyssey-babel-preset",
          {
            react: {
              runtime: "classic",
            },
          },
        ],
      ],
    },
  },
};
```

## License

[Apache Version 2.0](https://github.com/okta/odyssey/blob/main/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.