Skip to content

Latest commit

 

History

History
54 lines (52 loc) · 14.9 KB

RIPPLE_COMPONENTS.md

File metadata and controls

54 lines (52 loc) · 14.9 KB

Ripple component library packages

Package Version Description
@dpc-sdp/ripple-button Version A button themed element. Will be a <button> by default, or a an <a> if a href is provided.
@dpc-sdp/ripple-global Version The core styles and utilities used by all ripple components. Includes sets of colours, fonts, breakpoints.
@dpc-sdp/ripple-grid Version A grid system for page layout.
@dpc-sdp/ripple-icon Version A configurable SVG, sprite-based icon set for use with ripple components.
@dpc-sdp/ripple-link Version Components for creating page links in plain text, and with accompanying icon. External links open in a new window by default.
@dpc-sdp/ripple-meta-tag Version A link component to represent tags.
@dpc-sdp/ripple-responsive-img Version A component which renders an image with optimised sources for each breakpoint using kraken.io querystrings
@dpc-sdp/ripple-alert Version A set of components to display alert notifications.
@dpc-sdp/ripple-anchor-links Version A table of contents for use on article pages.
@dpc-sdp/ripple-breadcrumbs Version A compoennt to display the active path, with links. Does not display on small screens.
@dpc-sdp/ripple-card Version Card-themed containers for content such as events and dates, navigation, featured, promotional. Recommended implementation using the grid component.
@dpc-sdp/ripple-contact Version Contact information panel for displaying address, phone, social media. Recommended for use in sidebars.
@dpc-sdp/ripple-data-table Version Designed for use-cases that are focused around handling large amount of tabular data.
@dpc-sdp/ripple-description-list Version A list of descriptions.
@dpc-sdp/ripple-document-link Version A component for rendering a document download link.
@dpc-sdp/ripple-embedded-video Version A component for embedding video with transcript.
@dpc-sdp/ripple-figure Version A component for displaying an image with a caption.
@dpc-sdp/ripple-form Version A component for generating interactive forms. Uses Vue Form Generator. See documentation for creating fields.
@dpc-sdp/ripple-layout Version Standard grid-based layouts for structuring pages. Includes skip to content link.
@dpc-sdp/ripple-list Version List component for displaying an icon and text in a list.
@dpc-sdp/ripple-list-group Version A container for displaying lists of components.
@dpc-sdp/ripple-pagination Version A component for displaying a pagination bar with controls to change current step.
@dpc-sdp/ripple-print-this Version A component to print current page, recommended for sidebar.
@dpc-sdp/ripple-publish-date-and-author Version A component for displaying the date, location and author of an article.
@dpc-sdp/ripple-related-links Version A component for displaying internal / external links related to an article. Recommended for use in sidebars.
@dpc-sdp/ripple-search Version Components for generating a search field with filters, and search results.
@dpc-sdp/ripple-share-this Version A component for displaying social media buttons to share articles. Recommended for use in sidebars.
@dpc-sdp/ripple-sitemap Version A component to display nested, navigational links.
@dpc-sdp/ripple-timeline Version A timeline component for displaying sequential items.
@dpc-sdp/ripple-whats-next Version A component to display a list of links relating to additional content for an article. Recommended for use in sidebars.
@dpc-sdp/ripple-accordion Version An interactive component for showing and hiding markup.
@dpc-sdp/ripple-call-to-action Version A component for displaying key content with image and link.
@dpc-sdp/ripple-campaign-primary Version A component to showcase a main content preview with an image. Should be used along with Campaign Secondary.
@dpc-sdp/ripple-campaign-secondary Version A component to showcase secondary content previews. Should be used along with Campaign Primary.
@dpc-sdp/ripple-event Version A set of components for displaying events.
@dpc-sdp/ripple-grants Version Components for displaying Grants information.
@dpc-sdp/ripple-hero-banner Version A component to display a page heading, subtext and useful links.
@dpc-sdp/ripple-image-gallery Version A component to display images as an interactive gallery. This component only works client-side.
@dpc-sdp/ripple-link-tiles Version A component displaying links as tiles in a row or grid format.
@dpc-sdp/ripple-markup Version A component to wrap wysiwyg fields and process markup.
@dpc-sdp/ripple-news Version Components for displaying news articles.
@dpc-sdp/ripple-profile Version Components for displaying Component information.
@dpc-sdp/ripple-publication Version A package for publication components.
@dpc-sdp/ripple-site-footer Version Site footer for displaying common and useful links on all pages.
@dpc-sdp/ripple-site-header Version Site header for providing site-wide navigation and search on all pages.
@dpc-sdp/ripple-site-section-navigation Version Sub page navigation component. Recommended for use in sidebars.
@dpc-sdp/ripple-updated-date Version A component for displaying the date an article was last changed.