@arc-core-components/element_headline

Arc Core Component that represents a headline element.

Usage no npm install needed!

<script type="module">
  import arcCoreComponentsElementHeadline from 'https://cdn.skypack.dev/@arc-core-components/element_headline';
</script>

README

Element Headline: An Arc Core Component

What does this do?

When used in a Fusion Project, this Core Component can be used to render the Headline and optional Subheadline of an ANS Story, with an optional URL for both.

How do I use it?

import Headline from "@arc-core-components/element_headline";

<Headline
  headlineContainerClasses={headlineContainerClasses}
  headlineClasses={headlineClasses}
  headlineLevel={headlineLevel}
  headlineText={headlineText}
  subdheadlineClasses={subheadlineClasses}
  subheadlineLevel={subheadlineLevel}
  subheadlineText={subheadlineText}
  url={url}
/>;

Take a look in the src/index.mdx file to see suggested implementations.

How can I view what's in there quickly?

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

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.