Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content-authoring/components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ For more information on each component, click on the link in the table below. Yo

### How do you know which component to use? <a href="#addingcomponents-wip-howdoyouknowwhichcomponenttouse" id="addingcomponents-wip-howdoyouknowwhichcomponenttouse"></a>

There is no right or wrong component to use. The decision should be based on what you are trying to output. To get started, we recommend clicking on the Storybook links below to visualise each component. At that point, you can decide which component fits the needs of your specific situation.
There is no right or wrong component to use. The decision should be based on what you are trying to output. At that point, you can decide which component fits the needs of your specific situation.

<table><thead><tr><th width="192">Component</th><th width="435">Description</th><th>Storybook</th></tr></thead><tbody><tr><td><a href="content.md">Content</a></td><td>Adds a block of text</td><td>Link</td></tr><tr><td><a href="accordion.md">Accordion</a></td><td>Adds collapsible panes of content</td><td>Link</td></tr><tr><td><a href="attachment.md">Attachment</a></td><td>Card with title, body and attachments</td><td>Link</td></tr><tr><td><a href="automated-list.md">Automated list</a></td><td>Create an automated list that can be displayed as Navigation cards or Promo cards </td><td>Link</td></tr><tr><td><a href="callout.md">Callout</a></td><td></td><td>Link</td></tr><tr><td><a href="campaign.md">Campaign</a></td><td>A campaign style 'block' with an image, title text and body text</td><td>Link</td></tr><tr><td><a href="manual-list/event-card.md">Event card</a></td><td>Card tailored for events</td><td>Link</td></tr><tr><td><a href="manual-list/event-reference-card.md">Event reference card</a></td><td>Event card that pulls content automatically</td><td>Link</td></tr><tr><td><a href="iframe.md">iFrame</a></td><td>Embedded iFrame</td><td>Link</td></tr><tr><td><a href="manual-list/">Manual list</a></td><td>Configurable list of content that uses additional sub-components</td><td>Link</td></tr><tr><td><a href="map.md">Map</a></td><td>Location and embedded map</td><td>Link</td></tr><tr><td><a href="manual-list/navigation-card.md">Navigation card</a></td><td></td><td>Link</td></tr><tr><td><a href="manual-list/navigation-reference-card.md">Navigation reference card</a></td><td></td><td>Link</td></tr><tr><td><a href="next-step.md">Next step</a></td><td>Clickable card with title, body and link</td><td>Link</td></tr><tr><td><a href="quote.md">Quote</a></td><td>Quotation with body and author fields</td><td>Link</td></tr><tr><td><a href="manual-list/promo-card.md">Promo card</a></td><td>Card with image, date, title, body and CTA button</td><td>Link</td></tr><tr><td><a href="manual-list/promo-reference-card.md">Promo reference card</a></td><td>Promo card that pulls content automatically</td><td>Link</td></tr><tr><td><a href="manual-list/publication-card.md">Publication card</a></td><td>Card that includes document link</td><td>Link</td></tr><tr><td><a href="manual-list/service-card.md">Service card</a></td><td>Card that includes one or more links</td><td>Link</td></tr><tr><td><a href="slider.md">Slider</a></td><td>Image slider (similar to carousel effect)</td><td>Link</td></tr><tr><td><a href="manual-list/subject-card.md">Subject card</a></td><td></td><td>Link</td></tr><tr><td><a href="manual-list/subject-reference-card.md">Subject reference card</a></td><td>Subject card that pulls content automatically</td><td>Link</td></tr><tr><td><a href="webform.md">Webform</a></td><td>Webforms</td><td>Link</td></tr></tbody></table>
<table><thead><tr><th width="192">Component</th><th width="600">Description</th></tr></thead><tbody><tr><td><a href="content.md">Content</a></td><td>Adds a block of text</td></tr><tr><td><a href="accordion.md">Accordion</a></td><td>Adds collapsible panes of content</td></tr><tr><td><a href="attachment.md">Attachment</a></td><td>Card with title, body and attachments</td></tr><tr><td><a href="automated-list.md">Automated list</a></td><td>Create an automated list that can be displayed as Navigation cards or Promo cards </td></tr><tr><td><a href="callout.md">Callout</a></td><td></td></tr><tr><td><a href="campaign.md">Campaign</a></td><td>A campaign style 'block' with an image, title text and body text</td></tr><tr><td><a href="manual-list/event-card.md">Event card</a></td><td>Card tailored for events</td></tr><tr><td><a href="manual-list/event-reference-card.md">Event reference card</a></td><td>Event card that pulls content automatically</td></tr><tr><td><a href="iframe.md">iFrame</a></td><td>Embedded iFrame</td></tr><tr><td><a href="manual-list/">Manual list</a></td><td>Configurable list of content that uses additional sub-components</td></tr><tr><td><a href="map.md">Map</a></td><td>Location and embedded map</td></tr><tr><td><a href="manual-list/navigation-card.md">Navigation card</a></td><td></td></tr><tr><td><a href="manual-list/navigation-reference-card.md">Navigation reference card</a></td><td></td></tr><tr><td><a href="next-step.md">Next step</a></td><td>Clickable card with title, body and link</td></tr><tr><td><a href="quote.md">Quote</a></td><td>Quotation with body and author fields</td></tr><tr><td><a href="manual-list/promo-card.md">Promo card</a></td><td>Card with image, date, title, body and CTA button</td></tr><tr><td><a href="manual-list/promo-reference-card.md">Promo reference card</a></td><td>Promo card that pulls content automatically</td></tr><tr><td><a href="manual-list/publication-card.md">Publication card</a></td><td>Card that includes document link</td></tr><tr><td><a href="manual-list/service-card.md">Service card</a></td><td>Card that includes one or more links</td></tr><tr><td><a href="slider.md">Slider</a></td><td>Image slider (similar to carousel effect)</td></tr><tr><td><a href="manual-list/subject-card.md">Subject card</a></td><td></td></tr><tr><td><a href="manual-list/subject-reference-card.md">Subject reference card</a></td><td>Subject card that pulls content automatically</td></tr><tr><td><a href="webform.md">Webform</a></td><td>Webforms</td></tr></tbody></table>