Package Exports
- @legendarymediatv/bootstrap
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@legendarymediatv/bootstrap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
LegendaryMediaTV Bootstrap
This is a Node.js package for extending React Bootstrap (which is based on Bootstrap 5) and Gatsby 3 or 4. It also has components for class-based icons (i.e., FontAwesome, Bootstrap icons, etc.).
Recent changes
- v3.3.0- added an <Alert>component withtitle,subtitle, anderrorproperties
 
- added an 
- v3.2.0- added a <ListGroup.Item>component withsubitemandsubactionsproperties
- added a sleep()function
 
- added a 
- v3.1- added a <Pagination>component that uses our Gatsby-friendly<Link>component
- made the <Demo>component more robust
- added a titleproperty to the<Spinner>component
- bugfix for <Link>opening internal links in a new tab when requested
- bugfix for the <ListGroup>default italics class ondisplaySubClassName
- updated the peer dependency for React Bootstrap to 2.x, since 2.0 stable released
- updated the peer dependency for Gatsby to 3.xor4.x
- updated Bootstrap CSS reference to 5.1.3
 
- added a 
For more information, check out the release notes and the changelog.
Getting started
Installation
Install peer dependencies (if they aren't already).
npm install react react-dom react-bootstrap gatsbyOptionally, install React Helmet (useful for linking Bootstrap resources).
npm install react-helmetInstall this package.
npm install @legendarymediatv/bootstrapNOTE: if you are still using Bootstrap 4.6.x and React Bootstrap 1.6.x, then you can use version 2.13.1 of this package, however, it is not continuing to be maintained
Preparation
Modify the Babel loader to transpile JSX for this package.
NOTE: not configuring this will result in the following error when running
gatsby build: ERROR #98123 WEBPACK – Generating development JavaScript bundle failed: Unexpected token
Sample /gatsby-node.js
exports.onCreateWebpackConfig = ({ actions, loaders, getConfig }) => {
  const config = getConfig();
  config.module.rules = [
    // omit the default rule where test === '\.jsx?$'
    ...config.module.rules.filter(
      (rule) => String(rule.test) !== String(/\.jsx?$/)
    ),
    // re-create it with custom exclude filter
    {
      // apply required Babel presets/plugins and merge in your configuration from `babel.config.js`.
      ...loaders.js(),
      test: /\.jsx?$/,
      // exclude all node_modules from transpilation, except for this plugin
      // NOTE: their pattern has "\/" but this has "[\\\/]" to support all OS path separators
      exclude: (modulePath) =>
        /node_modules/.test(modulePath) &&
        !/node_modules[\\\/]@legendarymediatv[\\\/]bootstrap/.test(modulePath),
    },
  ];
  // replace the webpack config with the modified object.
  actions.replaceWebpackConfig(config);
};Either import Bootstrap CSS or link Bootstrap into your layout or app file.
Sample /src/components/Layout.js (link, with FontAwesome)
import React from "react";
import { Helmet } from "react-helmet";
import Container from "react-bootstrap/Container";
const Layout = (props) => {
  return (
    <>
      <Helmet htmlAttributes={{ lang: "en" }}>
        <title>{props.title}</title>
        <meta name="description" content={props.description} />
        <link
          rel="stylesheet"
          href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css"
          integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3"
          crossorigin="anonymous"
        />
        <link
          rel="stylesheet"
          href="https://use.fontawesome.com/releases/v5.15.4/css/all.css"
        />
      </Helmet>
      <Container className="py-4">
        <h1 className="display-1">{props.title}</h1>
        {props.children}
      </Container>
    </>
  );
};
export default Layout;Finally, import the components as needed into your app/components.
Sample /src/pages/index.js
// dependencies
import React from "react";
// page layout template
import Layout from "../components/Layout";
// sample LegendaryMediaTV component
import Icon from "@legendarymediatv/bootstrap/Icon";
const SamplePage = () => {
  return (
    <Layout title="Page Title" description="Page Description">
      <Icon name="fas fa-camera" />
    </Layout>
  );
};
export default SamplePage;Components
NOTE: components can be imported at the package level or at the component level
// package-level
import { Demo } from '@legendarymediatv/bootstrap';
// component level (preferred)
import Demo from '@legendarymediatv/bootstrap/Demo';<Alert>
An extension of React Bootstrap’s <Alert> component, but with the ability to set a title, subtitle, and/or error. It provides <Alert.Heading> as is, but converts their <Alert.Link> to our Gatsby-friendly <Link> component.
import Alert from '@legendarymediatv/bootstrap/Alert';
…
<Alert
  title="Alert Title"
  subtitle="Alert subtitle"
  variant="info"
  onClose={() => {
    alert("Insert dismiss logic here");
  }}
  dismissible
>
  Some text with a <Alert.Link to="/sample">link</Alert.Link>
</Alert>
<Alert
  error={{
    error: "Request failed with status code 401",
    url: "/",
    method: "GET",
  }}
  onRetry={() => {
    alert("Insert retry logic here");
  }}
/>
<Alert error={["Field 1 is required", "Field 2 is required"]} />In addition to the properties provided by React Bootstrap’s <Alert> component, the following additional properties are available:
| Name | Type | Default | Description | 
|---|---|---|---|
| error | JSX | object | either a JSX component or an object containing keys for error/messageand optionallyurland/ormethod | |
| onRetry | function | when defined, a retry <Button>is rendered with this as itsonClick | |
| subtitle | JSX | if erroris an array, then'Please fix the following error(s):'; iferroris not an array, then'The server has encountered a situation it doesn’t know how to handle'; otherwise, blank | content that goes inside a <p>tag styled with aleadclass | 
| title | JSX | if erroris an array, then'Submission Error'; iferroris not an array, then'Process Error'; otherwise, blank | content that goes inside an <Alert.Heading>styled as a<div>with anh3class | 
| variant | string | 'danger'iferroris defined, otherwise'primary'(inherited) | Bootstrap theme color name | 
<BackgroundImage>
Set a background image so that it covers the whole screen without distorting and stays in place, regardless of scrolling.
import BackgroundImage from '@legendarymediatv/bootstrap/BackgroundImage';
…
<BackgroundImage src="/images/sample.jpg" />| Name | Type | Default | Description | 
|---|---|---|---|
| imageClassName | string | classNameproperty for the<img> | |
| imageStyle | object | styleproperty for the<img> | |
| src | string | required | path to the image file | 
<Blockquote>
Quote blocks of content using Bootstrap’s Blockquote.
import Blockquote from '@legendarymediatv/bootstrap/Blockquote';
…
<Blockquote>
  <p className="mb-0">
    A well-known quote, contained in a blockquote element.
  </p>
</Blockquote>
<Blockquote>
  <p>
    Success, meaningful success, begins when we take ownership and actively
    take responsibility for our part in the shortcomings of our life.
  </p>
  <Blockquote.Footer>
    Dr Eric Thomas,{" "}
    <cite>Greatness Is Upon You: Laying the Foundation</cite>
  </Blockquote.Footer>
</Blockquote><Breakpoint>
Quickly see what the current breakpoint is (e.g., “md”).
import Breakpoint from '@legendarymediatv/bootstrap/Breakpoint';
…
<Breakpoint />NOTE: This component is intended to be used for development purposes and probably should be removed before deploying your app
| Name | Type | Default | Description | 
|---|---|---|---|
| variant | string | 'info' | Bootstrap theme color name | 
<DatePicker>
Allow someone to select a date using a calendar popover.
import DatePicker from '@legendarymediatv/bootstrap/DatePicker';
…
// use React state to track selected date
const [componentState, setComponentState] = React.useState(null);
…
// select a new date
function dateHandler(selected) => {
  setComponentState(selected);
};
…
<DatePicker
  title="Contact Date"
  value={componentState}
  onChange={dateHandler}
/>TIP: You could make your date change handler set the value for a hidden form element in addition to setting the state so that the date is submitted with the other form values
| Name | Type | Default | Description | 
|---|---|---|---|
| title | JSX | Date Picker | popover title | 
| titleAs | elementType | <h3> | asproperty for the popover title | 
| variant | string | light | Bootstrap theme color name applied to the display button | 
<Demo>
This component is intended to be used for development purposes (e.g., testing your custom Bootstrap theme) by having everything all one one page!
<Display>
Bootstrap’s display heading typography classes.
- <Display.Heading1>
- <Display.Heading2>
- <Display.Heading3>
- <Display.Heading4>
- <Display.Heading5>
- <Display.Heading6>
import Display from '@legendarymediatv/bootstrap/Display';
…
<Display.Heading1>Display Heading 1</Display.Heading1>
<Display.Heading2>Display Heading 2</Display.Heading2>
<Display.Heading3>Display Heading 3</Display.Heading3>
<Display.Heading4>Display Heading 4</Display.Heading4>
<Display.Heading5>Display Heading 5</Display.Heading5>
<Display.Heading6>Display Heading 6</Display.Heading6>| Name | Type | Default | Description | 
|---|---|---|---|
| as | elementType | <h#>corresponding to the size | changes the HTML tag | 
<Flipper>
Flashcard-like component that can flip horizontally or vertically using a 3D effect either on hover or via an event.
import Flipper from '@legendarymediatv/bootstrap/Flipper';
…
<Flipper
  front={<h3>auto-flipper front content</h3>}
  frontClassName="bg-primary text-light p-2"
  back={<h3>auto-flipper back content</h3>}
  backClassName="bg-secondary text-light p-2"
/>
…
// use React state to track flipped state
const [componentState, setComponentState] = React.useState(false);
…
function flipHandler(event) => {
  // un-click the button
  event.preventDefault();
  // toggle flip state
  setComponentState(!componentState);
};
…
<Flipper
  front={
    <Button
      onClick={flipHandler}
      className="w-100"
    >
      click to flip to the back
    </Button>
  }
  frontClassName="d-flex align-items-stretch"
  back={
    <Button
      onClick={flipHandler}
      variant="secondary"
      className="w-100"
    >
      click to flip to the front
    </Button>
  }
  backClassName="d-flex align-items-stretch"
  className="text-center"
  height="10rem"
  flipped={componentState}
  horizontal
/>| Name | Type | Default | Description | 
|---|---|---|---|
| back | JSX | flipper back side content | |
| backClassName | string | classNameproperty for the back side of the flipper | |
| backStyle | object | styleproperty for the back side of the flipper | |
| front | JSX | flipper front side content | |
| frontClassName | string | classNameproperty for the front side of the flipper | |
| frontStyle | object | styleproperty for the front side of the flipper | |
| flipped | boolean | null | determines whether the card should display as flipped over (i.e., tie events to this property), if null, then it flips on hover | 
| height | string | 15rem | heightproperty to apply to thestylefor the flipper and both sides | 
| horizontal | boolean | false | flip the card horizontally instead of vertically | 
NOTE: if
flippedisnull, then doesn’t togglearia-labelfor the flipper sides, because it flips on an untracked hover action rather than an event
<FormGroup>
An extension of React Bootstrap’s <Form.Group>, which automatically contains a React Bootstrap <Form.Label>. The label then optionally includes a <InfoIcon> when the info property is set.
import FormGroup from '@legendarymediatv/bootstrap/FormGroup';
…
<FormGroup
  title="Sample textbox"
  info={<p>Things, <i>stuff</i>, <b>content</b>!</p>}
>
  <Form.Control
    name="sample"
    maxLength="80"
    defaultValue="eleventeen"
  />
</FormGroup>| Name | Type | Default | Description | 
|---|---|---|---|
| ref | ReactRef | inherited | refproperty for the<Form.Group> | 
| as | elementType | inherited | asproperty for the<Form.Group> | 
| controlId | string | inherited | controlIdproperty for the<Form.Group> | 
| info | JSX | popover content for the <InfoIcon> | |
| infoAlt | string | inherited | altproperty for the<InfoIcon> | 
| infoClassName | string | classNameproperty for the<InfoIcon> | |
| infoStyle | object | styleproperty for the<InfoIcon> | |
| infoName | string | inherited | nameproperty for the<InfoIcon> | 
| infoTitle | JSX | titleproperty | titleproperty for the<InfoIcon> | 
| infoTitleAs | elementType | inherited | titleAsproperty for the<InfoIcon> | 
| infoVariant | string | inherited | variantproperty for the<InfoIcon> | 
| iconClassName | string | classNameproperty for the<InfoIcon> | |
| iconStyle | object | styleproperty for the<InfoIcon> | |
| title | JSX | content for the <Form.Label> | |
| labelRef | ReactRef | inherited | refproperty for the<Form.Label> | 
| labelAs | elementType | inherited | asproperty for the<Form.Label> | 
| column | boolean | 'sm'|'lg' | inherited | columnproperty for the<Form.Label> | 
| htmlFor | string | inherited | htmlForproperty for the<Form.Label> | 
| visuallyHidden | boolean | inherited | visuallyHiddenproperty for the<Form.Label> | 
| labelClassName | string | classNameproperty for the<Form.Label> | |
| labelStyle | object | styleproperty for the<Form.Label> | 
<FullPage>
Make your page always use at least the full height of the browser window using flexbox instead of fixed/sticky styling. Plus, it has a footer component that will display at the bottom of the page without forcing a scrollbar!
This component set doesn't have any special properties, but it is made up of three parts:
- <FullPage>– the wrapper (should only contain the other FullPage components below)
- <FullPage.Content>(required) – page content (should contain your- <Navbar>and page copy components such as- <article>)
- <FullPage.Footer>(optional) – page footer (can be styled directly or given an- idand styled elsewhere)
import FullPage from '@legendarymediatv/bootstrap/FullPage';
…
<FullPage>
  <FullPage.Content>Page Content</FullPage.Content>
  <FullPage.Footer>Footer Content</FullPage.Footer>
</FullPage>Containerized example:
<div className="bg-dark">
  <Container className="bg-light p-0">
    <FullPage>
      <FullPage.Content>
        <Navbar bg="primary" variant="dark">
          <Navbar.Brand>LegendaryMediaTV</Navbar.Brand>
        </Navbar>
        <article className="py-4 px-2">
          <h1>Title or whatever</h1>
          <p>Things, stuff, content!</p>
        </article>
      </FullPage.Content>
      <FullPage.Footer className="bg-secondary py-2 text-center text-white">
        Footer Content
      </FullPage.Footer>
    </FullPage>
  </Container>
</div>NOTE: if using React Helmet, you can use its
bodyAttributesproperty instead of a<div>wrapper to set the main background color:<Helmet bodyAttributes={{ class: "bg-dark" }}>
<Icon>
Class-based icon (<i> tag) that can automatically add an ARIA label based on the icon name.
import Icon from '@legendarymediatv/bootstrap/Icon';
…
<Icon name="fas fa-camera" />
<Icon
  name="fas fa-camera"
  alt="DSLR"
  variant="success"
  className="ms-3"
  style={{ fontSize: '2rem' }}
/>| Name | Type | Default | Description | 
|---|---|---|---|
| alt | string | variation of name(e.g.,'camera') | alternate text for the icon (i.e., ends up in aria-label) | 
| name | string | required | icon class name (e.g., 'fas fa-camera') | 
| variant | string | Bootstrap theme color name (e.g., 'primary') | 
<InfoIcon>
An extension of React Bootstrap’s <Popover> (with rootClose set to auto-close when it loses focus) that contains an <Icon>.
import InfoIcon from '@legendarymediatv/bootstrap/InfoIcon';
…
<InfoIcon title="Info Title">Info Content</InfoIcon>
<InfoIcon
  title="Info Title"
  name="bi bi-info-circle-fill"
  alt="help me!"
  variant="danger"
  iconStyle={{ fontSize: "2rem" }}
>
  Things, <i>stuff</i>, <b>content</b>!
</InfoIcon>| Name | Type | Default | Description | 
|---|---|---|---|
| children | JSX | popover content | |
| alt | string | variation of name(e.g.,'camera') | alternate text for the <Icon>(i.e., ends up inaria-label) | 
| iconClassName | string | classNameproperty for the<Icon>(i.e.,classNameis applied to the toggler button) | |
| iconStyle | object | styleproperty for the the<Icon>(i.e.,styleis applied to the toggler button) | |
| name | string | 'fas fa-question-circle' | icon class name | 
| title | JSX | popover title | |
| titleAs | elementType | <h3> | asproperty for the popover title | 
| variant | string | info | Bootstrap theme color name applied to the icon | 
<Link>
A combination of an HTML <a> tag and Gatsby’s <Link>. It mostly uses the normal <a> tag properties, but accepting either href or to in order to set the URL, so that you can simply swith the import of Gatsby’s <Link> to this one instead, plus you can set the as property for any React Bootstrap to be this component so that links work properly in Gatsby.
If href property begins with # (i.e., anchor), a protocol (e.g., https:// or mailto:), or ends with a file extension (e.g., sample.jpg), or external is set, then it uses an <a> tag. Otherwise, it uses Gatsby’s <Link> tag, so that it doesn’t force a page reload.
import Link from '@legendarymediatv/bootstrap/Link';
…
<Link href="/">Gatsby link</Link>
<Link href="#link">HTML link</Link>
<Link href="https://www.legendarymediatv.com">auto-external HTML link</Link>
<Link
  href="/external-somehow"
  externalIcon="bi bi-box-arrow-up-right"
  externalVariant="danger"
>
  HTML link with custom external icon and color
</Link>
<Navbar.Brand as={Link} to='/'>LegendaryMediaTV</Navbar.Brand>
<Nav.Link as={Link} to='/'>Home</Nav.Link>| Name | Type | Default | Description | 
|---|---|---|---|
| href|to | URL | required | URL or anchor target | 
| external | boolean | trueif the URL starts withhttp:orhttps:orexternalIconis set | explicitly (un-)flag an external link icon (also forces an <a>tag when enabled), which goes inside its own<small>tag | 
| externalNewTab | boolean | false | set newTabtotruewhenexternalistrue | 
| externalIcon | icon class name | 'fas fa-external-link-alt' | external icon class name | 
| externalVariant | string | info | Bootstrap theme color name (e.g., 'primary') applied to the icon | 
| externalClassName | string | 'small ps-1 align-text-top' | classNameproperty for the<Icon>(i.e.,classNameis applied to the toggler button) | 
| externalStyle | object | styleproperty for the the<Icon>(i.e.,styleis applied to the toggler button) | |
| newTab | boolean | false | force the link to open in a new tab (sets target="_blank" rel="noopener") | 
<ListGroup>
An extension of React Bootstrap’s <ListGroup> that has a title, accepting arrays of URL strings and arrays of obects as items. If the item has a URL, then it is rendered as our Gatsby-friendly <Link> component, otherwise it is rendered as our <ListGroup.Item> instead.
import ListGroup from '@legendarymediatv/bootstrap/ListGroup';
…
const linkArray = [
  '/test',
  '/sample'
];
…
<ListGroup title="Array of Links" items={linkArray} />
…
const linkObjects = [
  { title: 'Test Link', url: '/test' },
  {
    title: 'Sample Link',
    subtitle: "additional information in a subtitle",
    url: '/sample'
  }
];
…
<ListGroup title="Array of Objects with Links" items={linkObjects} />
…
function sampleHandler(itemSelected) {
  alert(JSON.stringify(itemSelected, null, 4));
}
…
const objectArray = [
  { id: 1, title: 'Test Non-Link' },
  { id: 2, title: 'Sample Non-Link' }
];
…
<ListGroup
  title="Array of Objects with Click Handler"
  titleVariant="success"
  items={objectArray}
  click={sampleHandler}
  className="mt-3"
/>| Name | Type | Default | Description | 
|---|---|---|---|
| activeKey | unknown | inherited | activeKeyproperty | 
| as | elementType | inherited | asproperty for the list group | 
| defaultActiveKey | unknown | inherited | defaultActiveKeyproperty | 
| horizontal | true|'sm'|'md'|'lg'|'xl' | inherited | horizontalproperty | 
| onSelect | function | inherited | when itemsis an array of objects, this is theonClickcallback function that passes the clicked item as an argument | 
| variant | 'flush' | inherited | variantproperty | 
| displayField | string | 'title' | when itemsis an array of objects, this is the object field to display | 
| displaySubField | string | 'subtitle' | when itemsis an array of objects, this is the object field to subtly display below thedisplayField | 
| displaySubClassName | string | fst-italic small text-muted | when itemsis an array of objects, this is theclassNameproperty for thedisplaySubField | 
| items | string[] or object[] | required | array of URL strings or an array of objects | 
| itemsAs | elementType | inherited | asproperty for the list group items | 
| keyField | string | 'id' | when itemsis an array of objects, this is the object field to use as the React list key; otherwise it just uses the array index as the key | 
| title | string | list group title | |
| titleAs | elementType | <h3> | asproperty for the list group title | 
| titleVariant | string | 'primary' | Bootstrap theme color name for the list group title | 
| titleClassName | string | classNameproperty for the list group title | |
| titleStyle | object | styleproperty for the list group title | |
| urlField | string | 'url' | when itemsis an array of objects, this is the object field to use as the link URL | 
<ListGroup.Item>
An extension of React Bootstrap’s <ListGroup.Item> that adds support for sub-items, sub-actions, auto-conversion to a Gatsby-friendly <Link> when a URL is provided, and auto-conversion to an action when a URL or click handler are defined.
The subactions property should be an array of objects corresponding containing <ListGroup.Item> properties.
import ListGroup from '@legendarymediatv/bootstrap/ListGroup';
…
<ListGroup
  title="ListGroup with items"
  titleVariant="info"
>
  <ListGroup.Item subitem="sample sub-item">
    ListGroup.Item with a sub-item below
  </ListGroup.Item>
  <ListGroup.Item to="/sample">
    ListGroup.Item auto-converted to a link/action
  </ListGroup.Item>
  <ListGroup.Item
    onClick={() => {
      alert("clicked");
    }}
  >
    ListGroup.Item auto-converted to a button
  </ListGroup.Item>
  <ListGroup.Item
    to="#list-group"
    subactions={[
      {
        to: "/sample",
        variant: "info",
        children: <Icon name="fas fa-camera" />,
      },
      {
        onClick: () => {
          alert("deleted!");
        },
        variant: "danger",
        children: <Icon name="fas fa-trash-alt" />,
      },
    ]}
  >
    ListGroup.Item with a URL and sub-actions
  </ListGroup.Item>
</ListGroup.Item>| Name | Type | Default | Description | 
|---|---|---|---|
| action | boolean | inherited / true | marks the item as actionable; will be set to truewhenhref/to/onClickare defined | 
| active | boolean | inherited | marks the item as active | 
| as | elementType | inherited / Link | asproperty for the item; becomes our Gatsby-friendlyLinkwhen thehrefortoproperty is defined | 
| children | JSX | content for the main list item (will be nested if subactionsproperty is set) | |
| disabled | boolean | inherited | marks the item as disabled | 
| eventKey | string | number | inherited | unique identifier for when using events | 
| href|to | URL | URL or anchor target for the <Link> | |
| onClick | function | fired when the item is clicked | |
| subitem | JSX | to subtly display below the children | |
| subitemClassName | string | 'fst-italic small text-muted' | classNameproperty for thesubitem | 
| variant | string | Bootstrap theme color name (e.g., 'primary') | 
<Pagination>
Basically a rebuild of React Bootstrap’s <Pagination> and <PageItem> components, but based off of our <Link> component (in order to be Gatsby-friendly).
Sub-components include:
- <Pagination.Item>– creates a pagination item containing a- <Link>or- <button>(native), depending on if a URL is provided in the- href/- toproperty
- <Pagination.First>–- <Pagination.Item>with the content as an ARIA-friendly- «by default
- <Pagination.Last>–- <Pagination.Item>with the content as an ARIA-friendly- »by default
- <Pagination.Prev>–- <Pagination.Item>with the content as an ARIA-friendly- ‹by default
- <Pagination.Next>–- <Pagination.Item>with the content as an ARIA-friendly- ›by default
- <Pagination.Ellipsis>–- <Pagination.Item>with the content as an ARIA-friendly- …by default
TIP: if you prefer to use icons, you can override the default content of any of the above by making the child an
<Icon>
import Pagination from '@legendarymediatv/bootstrap/Pagination';
…
<Pagination>
  <Pagination.First />
  <Pagination.Prev />
  <Pagination.Ellipsis />
  <Pagination.Item>1</Pagination.Item>
  <Pagination.Item to="/sample">2</Pagination.Item>
  <Pagination.Item onClick={sampleHandler.bind(this, 3)}>3</Pagination.Item>
  <Pagination.Item active>4</Pagination.Item>
  <Pagination.Item disabled>5</Pagination.Item>
  <Pagination.Ellipsis />
  <Pagination.Next />
  <Pagination.Last />
</Pagination>
…
<Pagination size="sm">
  <Pagination.First>
    <Icon name="fas fa-angle-double-left" alt="first" />
  </Pagination.First>
  <Pagination.Prev>
    <Icon name="fas fa-angle-left" alt="previous" />
  </Pagination.Prev>
  <Pagination.Ellipsis>
    <Icon name="fas fa-ellipsis-h" alt="more" />
  </Pagination.Ellipsis>
  <Pagination.Next>
    <Icon name="fas fa-angle-right" alt="next" />
  </Pagination.Next>
 <Pagination.Last>
    <Icon name="fas fa-angle-double-right" alt="last" />
  </Pagination.Last>
</Pagination><Pagination> properties
| Name | Type | Default | Description | 
|---|---|---|---|
| size | 'sm'|'lg' | sets the sizing for the whole pagination | 
<Pagination.*> properties
| Name | Type | Default | Description | 
|---|---|---|---|
| active | boolean | false | sets the pagination item as activeand appends the children with a<VisuallyHidden>tag containing theactiveLabel | 
| activeLabel | string | (current) | content of the <VisuallyHidden>tag when flagged asactive | 
| disabled | boolean | false | sets the pagination item as disabled | 
| href|to | URL | URL or anchor target for the <Link>; if blank, then a<button>is rendered and probably should have anonClickdefined | |
| onClick | function | callback function for when the component is clicked; TIP: as in the example above, use bind()when assigning the property in order to tell which pagination item is clicked | 
<ScrollToTop>
Customizable icon that automatically appears in the bottom-right corner when you’re scrolled down the page a bit and smoothly scrolls to the top of the page when clicked.
import ScrollToTop from '@legendarymediatv/bootstrap/ScrollToTop';
…
<ScrollToTop />
<ScrollToTop name="fas fa-caret-square-up" variant="success" />NOTE: the
scrollToTop()handler function can be exported as well; see below for details
| Name | Type | Default | Description | 
|---|---|---|---|
| alt | string | 'up arrow' | alternate text for the icon (i.e., ends up in aria-label) | 
| name | string | 'fas fa-chevron-circle-up' | icon class name | 
| variant | string | 'dark' | Bootstrap theme color name | 
| iconClassName | string | classNameproperty for the<Icon> | |
| iconStyle | object | styleproperty for the<Icon> | 
<Spinner>
An extension of React Bootstrap’s <Spinner> that automatically selects the border animation and adds the screen reader and ARIA role, so it can be self-closing and easily ensure the maximum accessibility.
import Spinner from '@legendarymediatv/bootstrap/Spinner';
…
<Spinner />
<Spinner
  animation="grow"
  variant="success"
/>
<Spinner alert />
<Spinner
  title="Reticulating splines …"
  variant="primary"
/>| Name | Type | Default | Description | 
|---|---|---|---|
| children | JSX | 'loading…' | content for <VisuallyHidden>child component | 
| animation | 'border'|'grow' | 'border' | changes the animation style of the spinner | 
| alert | boolean | false | wrap the spinner in an <Alert>(centered withpy-5padding), defaultingvariantto'info', and apply non-spinner properties to the alert | 
| as | string | 'div' | custom HTML tag | 
| role | string | 'status' | ARIA accessibility role | 
| size | string | component size variations (e.g., sm) | |
| title | JSX | content for <Alert.Heading>, also wraps the spinner in an<Alert>(centered withpy-4padding), seealertabove | |
| variant | string | 'primary' | Bootstrap theme color name (e.g., 'primary') | 
<VisuallyHidden>
Bootstrap’s visually hidden content (a.k.a., screen reader only).
import VisuallyHidden from '@legendarymediatv/bootstrap/VisuallyHidden';
…
<p className="text-danger">
  <VisuallyHidden>Danger: </VisuallyHidden>
  This action is not reversible
</p>
| Name | Type | Default | Description | 
|---|---|---|---|
| focusable | boolean | false | item is focusable | 
Functions
combine(array) and separate(string)
Use separate() to split a string (e.g., className) by whitespace into an array, always returning at least an empty array.
Use combine() to join an array with at least one element via a space separator, otherwise return null.
NOTE: these are helpful when used together or in conjunction with
prepare()in order to joinclassNamebefore rendering the component; see the example there
prepare(props)
A React component's properties cannot be altered, so use this function to create a new properties array and children variable. Then, manipulate the array as you see fit, and spread out the new properties in your component.
import { combine, prepare } from "@legendarymediatv/bootstrap/functions";
…
// prepare properties
const [properties, children] = prepare(props);
// add variant to class
properties.className.push(`text-${properties.variant}`);
delete properties.variant;
// merge classes
properties.className = combine(properties.className);
// render component
return (
  <div {...properties}>{children}</div>
);NOTE: this is helpful when used in conjunction with
prepare(props)in order to joinclassNamebefore rendering the component
formData(formObject)
Pass this function a form object (e.g., via an onSubmit event handler’s event.target) and it will return a JSON object containing the form’s element data as key–value pairs. Key names are pulled from either the form element name (preferred) or id attribute, otherwise unnamed/unidentified elements are omitted. Unselected radio elements are ignored as well.
NOTE: JSON data returned from this function could be utilized in API calls via extensions like Axios
import { formData } from "@legendarymediatv/bootstrap/functions";
...
const submitHander = (event) => {
  // don't traditionally submit the form
  event.preventDefault();
  // extract data from the form
  const data = formData(event.target);
  // display the form data object
  alert(JSON.stringify(data, null, 4));
}
...
<Form onSubmit={submitHandler}>
  <FormGroup title="Simple textbox">
    <Form.Control name="sample" />
  </FormGroup>
  <Button type="submit">Submit</Button>
</Form>sleep(milliseconds)
Promise-based wrapper for JavaScript’s setTimeout() function, allowing your script to pause using await or .then() syntax.
import { sleep } from '@legendarymediatv/bootstrap/functions';
…
// wait one second and then do something
sleep(1000)
  .then(() => {
    // do something
  });
function async sample() {
  // do something
  // wait 1/4 second
  await sleep(250);
  // do something else
}| Name | Type | Default | Description | 
|---|---|---|---|
| milliseconds | integer | required | number of milliseconds to wait | 
title(site, title, parent)
Generate an SEO-friendly HTML title in the format Title | Site. Optionally, include the parent argument to render Title – Parent | Site. Also, if title and parent are omitted, then it just uses the site.
NOTE: this is designed to be used in conjunction with a plugin like React Helmet
import { title } from '@legendarymediatv/bootstrap/functions';
…
<Helmet>
  <title>{title("LegendaryMediaTV", "Bootstrap Demo")}</title>
</Helmet>
<Helmet>
  <title>
    {title("LegendaryMediaTV", "Full Page Demo", "Bootstrap Demo")}
  </title>
</Helmet>| Name | Type | Default | Description | 
|---|---|---|---|
| site | string | required | site/company name | 
| title | string | this page’s title | |
| parent | string | parent page’s title | |
| siteSeparator | string | pipe: | | separator between the siteand thetitle/parent | 
| parentSeparator | string | en dash: '–' | separator between the titleandparent | 
| separatorReplacer | string | forward slash: '/' | replacement character when titleorparentcontain theparentSeparator | 
scrollToTopHandler(event)
Add the ability for any component to smoothly scroll to the top of the window.
import { scrollToTopHandler } from '@legendarymediatv/bootstrap/ScrollToTop';
…
<Button onClick={scrollToTopHandler}>Scroll to Top</Button>
<Link to="#" onClick={scrollToTopHandler}>
  scroll to top
</Link>NOTE: see the
<ScrollToTop>component above for a turnkey 🦃 scroll-to-top solution
Additional examples
For more examples of usage, see /src/pages