README

Donation Form Section

This is the Donation Form Section WebComponent.

Installation

yarn add @internetarchive/donation-form-section

Demo

Usage

<script type="module">
  import '@internetarchive/donation-form-section';
</script>

<donation-form-section number="1" headline="A nice catchy headline" numberMode="shownumber">
  <div class="section-content">Some nice content here</div>
</donation-form-section>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

yarn run lint

You can lint with ESLint and Prettier individually as well

yarn run lint:eslint

yarn run lint:prettier

To automatically fix many linting errors, run

yarn run format

You can format using ESLint and Prettier individually as well

yarn run format:eslint

yarn run format:prettier

Testing with Karma

To run the suite of karma tests, run

yarn run test

To run the tests in watch mode (for TDD, for example), run

yarn run test:watch

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with `es-dev-server`

yarn start

To run a local development server that serves the basic demo located in demo/index.html

Usage no npm install needed!