@arc-core-components/feature_global-amp-gallery

AMP gallery for article pages.

Usage no npm install needed!

<script type="module">
  import arcCoreComponentsFeatureGlobalAmpGallery from 'https://cdn.skypack.dev/@arc-core-components/feature_global-amp-gallery';
</script>

README

Feature: Amp Gallery

What does this do?

When used in a Fusion Project, this Core Component can be used to render a gallery that is compliant with amp, using the amp-carousel component.

How do I use it?

  import AMPCarousel from '@arc-core-components/feature_global-amp-gallery'

  <AMPCarousel {..yourProps}></AMPCarousel>

Take a look in the src file to see a suggested implementation, in index.mdx

How can I view what's in there quickly?

Run npm i && npm run docz:dev after cloning to see what is within.

Amp Notes:

Read the amp-carousel documentation

Testing & Linting

We are using Jest and XO for testing and linting.

We are using Husky to run a pre-push hook, preventing un-linted or code that fails tests from making it into the repo.

To test: npm test

To lint: npm run lint - This will also fix any simple linter errors automatically.

To push without testing or linting: git push --no-verify - This can often be helpful if you just need to push a branch for demonstration purposes or for help.