> Checkout Spectrum Web Components which is a future-looking project to develop Adobe Spectrum design language based around web components, ES-Modules, and modern browser standards.

Coral Spectrum !Build Status

A JavaScript library of Web Components following Spectrum design patterns.

Important

Please follow the Commit Message Conventions. To easily comply, it is recommended to use cz-cli.

Showcase

#### Component Examples
To see all components in action. These are only examples and don't cover all scenarios.

#### API References
Covers the API for all components including properties, events and more.

#### Playground
Experiment and preview code with the latest Coral Spectrum version.
Code can be shared by copy pasting the URL. The playground is sandboxed to prevent security risks.

Spectrum

The current default theme is is an implementation of the Spectrum design
specifications, Adobe’s design system. Spectrum provides elements and tools to help product teams work more
efficiently, and to make Adobe’s applications more cohesive.

Coral Spectrum leverages the Spectrum CSS framework to style
components including the Spectrum SVG icons.

Angular, React, Vue.js compatibility

Our vision is to create consistent Adobe experiences by providing a complete, easy to use library of HTML components
compatible with major frameworks.

To reach the goal, Coral Spectrum derives from Custom Elements v1 with
native support thanks to broad collaboration between browser vendors.
The use of custom elements gives us the ability to hide many implementation details from the consumer, allowing much
more freedom to change the underlying markup that supports those elements.
This makes the exposed API smaller and more explicit, resulting in a lower risk of updates to Coral Spectrum needing to
introduce breaking changes.

Browser support

Coral Spectrum is designed to support the following browsers:
* Chrome (latest)
* Safari (latest)
* Firefox (latest)
* Edge (latest)
* IE 11
* iOS 7+
* Android 4.4+

Theme (light, dark, lightest, darkest)

The default Coral Spectrum styles cascade from coral--light, coral--lightest, coral--dark and coral--darkest theme, so that class must be specified at a higher level.

``html




`

Large scale support

For mobile, Spectrum has a larger scale that enables larger tap targets on all controls. To enable it, the class coral--large must be specified at a higher level.

`html




`

Built-in Accessibility and Keyboard support

Having an inaccessible application can mean thousands of dollars of fines if you land a government contract.
It also means alienating an entire segment of society by making your application completely unusable to them.
To help you avoid this, we’ve made it a rule that every Coral Spectrum component should be accessible.

Internationalization support

Coral Spectrum provides a robust internal system for internationalization of its strings.
This is done via an internal Adobe process.

Supported languages are :

Language family | Language tag | Language variant
--- | --- | ---
English | en-US | American English
French | fr-FR | Standard French
German | de-DE | Standard German
Italian | it-IT | Standard Italian
Spanish | es-ES | Castilian Spanish
Portuguese | pt-BR | Brazilian Portuguese
Japanese | ja-JP | Standard Japanese
Korean | ko-KR | Standard Korean
Chinese | zh-CN | Mainland China, simplified characters
Chinese | zh-TW | Taiwan, traditional characters
Dutch | nl-NL | Netherlands Dutch
Danish | da-DK | Standard Danish
Finnish | fi-FI | Standard Finnish
Norwegian | no-NO | Standard Norwegian
Swedish | sv-SE | Standard Swedish
Czech | cs-CZ | Standard Czech
Polish | pl-PL | Standard Polish
Russian | ru-RU | Standard Russian
Turkish | tr-TR | Standard Turkish

Using Coral Spectrum

$3

The easiest way to consume Coral Spectrum is to use a CDN e.g. copy these lines into your html file.

`html






My Button

`

$3

You can download a packaged/published version of @adobe/coral-spectrum from npm:

`
npm pack @adobe/coral-spectrum
`

After you've unzipped the downloaded package, look for the dist folder and :
* Copy the files from dist/css, dist/js and dist/resources in your project.
* Reference the files in your page e.g

`html


`

$3

npm install @adobe/coral-spectrum

then in your main js, use:

`
require("@adobe/coral-spectrum/dist/js/coral.js");
require("@adobe/coral-spectrum/dist/css/coral.css");
`

$3

If your project only requires a few components, you can use a module bundler like Webpack to only import the components needed.
Below is an example of a Webpack config:

`js
const path = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');

module.exports = {
mode: 'production',
devtool: 'source-map',
entry: './src/index.js',
output: {
filename: 'bundle.min.js',
path: path.resolve(__dirname, 'dist')
},
module: {
rules: [
{
test: /\.js$/,
use: {
loader: 'babel-loader',
options: {
presets: ['@babel/preset-env']
}
}
},
{
test: /\.svg$/,
use: [
{
loader: 'file-loader',
options: {
name: 'icons/[name].[ext]'
},
},
]
},
{
test: /\.css$/,
use: [MiniCssExtractPlugin.loader, 'css-loader']
}
]
},
plugins: [
new MiniCssExtractPlugin({
filename: 'style.min.css'
}),
new OptimizeCssAssetsPlugin({
assetNameRegExp: /style\.min\.css$/g,
cssProcessor: require('cssnano'),
cssProcessorPluginOptions: {
preset: ['default', { discardComments: { removeAll: true } }],
}
})
]
};
`

Then in your index.js file, you can import and use single components :

`js
// Import Component
import {Button} from '@adobe/coral-spectrum/coral-component-button';

const button = new Button();
`

If icons are not displayed, ensure the path to the styles and icons are set e.g. :

`html


`

If icons still do not display, you can try setting them to display as inline
SVGs, instead of external resources. Coral Spectrum will default to external
resources on browsers other than IE11. Using the previous example, this option
can be set with:

`html


`

Note: Calendar, Clock and Datepicker components will leverage moment.js if available.

Contributing

Check out the contributing guidelines.

$3

Run the following commands first :
`
npm install -g gulp-cli
npm install
`

You can use below tasks to get started:
* gulp to generate the build in the dist folder and run the dev server on localhost:9001 by default.
* gulp build to generate the build in the dist folder.
* gulp dev to run the dev server on localhost:9001 by default.
* gulp test to run the tests. Test reports are in dist/coverage.
* gulp docs to build the documentation in dist/documentation.
* gulp axe to run the accessibility checks.

Each component can be built independently e.g. cd coral-component-button && gulp.

$3


#### Automatic release:
Merging the PR to master will trigger an automatic release Github Action. It is important to follow Angular Commit Message Conventions. It is recommended to use cz-cli for easy commits.
Only fix and feat can trigger a release. If you want to skip release [add \[skip release\] or \[release skip\] to the commit message](https://semantic-release.gitbook.io/semantic-release/support/faq#can-i-exclude-commits-from-the-analysis)
#### Manual releasing:
We are currently releasing this package on npm.

Before we get started, clean up your dependencies with the following command :

`
git checkout master
rm -rf node_modules && npm install
`

Then run gulp release. You'll be asked to bump the version (minor version bump by default). Coral Spectrum is following
semantic versioning (either patch, minor or major).

The command will take care of increasing, tagging the version and publishing the package to npm.

If everything went well, run gulp deploy to publish the documentation on the gh-pages` branch else revert the version bump.