d2l-labs-attachment

Note: this is a "labs" component. While functional, these tasks are prerequisites to promotion to BrightspaceUI "official" status:

Design organization buy-in

design.d2l entry

Architectural sign-off

Continuous integration

Cross-browser testing

Unit tests (if applicable)

Accessibility tests

Visual diff tests

Localization with Serge (if applicable)

Demo page

README documentation

Activity attachments

Installation

To install from github:

npm install @brightspace/attachment

Usage

<script type="module">
    import '@brightspace/attachment/components/attachment.js';
</script>
<d2l-labs-attachment></d2l-labs-attachment>

TODO - Show usage examples

Developing, Testing and Contributing

After cloning the repo, run npm install to install dependencies.

Running the demos

To start a local web server that hosts stories (demos) written using Storybook:

npm run storybook

Testing

To lint (eslint and Polymer lint):

npm run lint

To run unit tests locally using Polymer test:

npm run test:polymer:local

To lint AND run local unit tests:

npm test

Versioning, Releasing & Deploying

All version changes should obey semantic versioning rules.

Include either [increment major], [increment minor] or [increment patch] in your merge commit message to automatically increment the package.json version and create a tag.

apalaniuk / attachment