@quintype/arrow 3.0.0-spike-skeleton-layout.21 → 3.0.0

package/src/components/Rows/FullScreenSlider/index.js

@@ -0,0 +1,114 @@
+import React from "react";
+import { useDispatch, useSelector } from "react-redux";
+import get from "lodash/get";
+
+import { CollectionName } from "../../Atoms/CollectionName";
+import { LoadmoreButton } from "../../Atoms/Loadmore";
+import { StoryCard } from "../../Molecules/StoryCard";
+import { collectionToStories } from "@quintype/components";
+import PropTypes from "prop-types";
+import { getTextColor, getNumberOfStoriesToShow, generateNavigateSlug, navigateTo } from "../../../utils/utils";
+import { StateProvider } from "../../SharedContext";
+import { ScrollSnap } from "../../Atoms/ScrollSnap";
+
+import "./full-screen-slider.m.css";
+
+const FullScreenSlider = ({ collection = {}, config = {} }) => {
+  const {
+    collectionNameBorderColor = "",
+    borderColor = "",
+    theme = "",
+    collectionNameTemplate = "",
+    isFullWidth = false,
+    numberOfStoriesToShow = 1,
+    contentAlignment = "",
+    footerButton = "",
+    footerSlotConfig = {},
+    navigationArrows = true,
+    slideIndicator = "none",
+    isInfinite = false
+  } = config;
+  const { footerSlot } = footerSlotConfig;
+  const items = collectionToStories(collection);
+  const containerStyle = isFullWidth ? "full-width" : "container-width";
+  const alignment = contentAlignment === "center" ? "content-align" : "";
+
+  if (items.length < 1) {
+    return null;
+  }
+
+  const dispatch = useDispatch();
+  const qtConfig = useSelector((state) => get(state, ["qt", "config"], {}));
+  const url = generateNavigateSlug(collection, qtConfig);
+
+  const showNumberOfStoriesToShow = getNumberOfStoriesToShow(numberOfStoriesToShow);
+  const textColor = getTextColor(theme);
+  const footerSlotComp = footerSlot ? footerSlot() : null;
+  return (
+    <div
+      className={`arrow-component full-width-with-padding ${containerStyle}`}
+      data-test-id="full-screen-slider"
+      styleName="full-screen-slider-wrapper"
+      style={{ backgroundColor: theme, color: textColor }}>
+      <div styleName={`full-screen-slider ${containerStyle}`}>
+        <span styleName={`${containerStyle}`}>
+          <CollectionName
+            styleName={`${containerStyle}`}
+            collection={collection}
+            collectionNameTemplate={collectionNameTemplate}
+            collectionNameBorderColor={collectionNameBorderColor}
+          />
+        </span>
+        <div styleName={`wrapper ${containerStyle} ${alignment}`}>
+          <ScrollSnap isArrow={navigationArrows} slideIndicator={slideIndicator} isInfinite={isInfinite}>
+            {items.slice(0, showNumberOfStoriesToShow).map((story, index) => {
+              return (
+                <StoryCard
+                  key={index}
+                  story={story}
+                  useImageAsBackground
+                  aspectRatio={[[16, 9], [4, 2]]}
+                  headerLevel={"1"}
+                  borderColor={borderColor}
+                  config={config}
+                />
+              );
+            })}
+          </ScrollSnap>
+        </div>
+        <LoadmoreButton
+          collection={collection}
+          template={footerButton}
+          config={config}
+          navigate={() => navigateTo(dispatch, url)}
+          qtConfig={qtConfig}
+        />
+        {footerSlotComp}
+      </div>
+    </div>
+  );
+};
+
+FullScreenSlider.propTypes = {
+  /**  collection is the array of objects which is returning by API  */
+  collection: PropTypes.object.isRequired,
+  /** The config for the Row */
+  config: PropTypes.shape({
+    // section tag border color
+    borderColor: PropTypes.string,
+    // backgroundColor and text color based on theme
+    theme: PropTypes.string,
+    // row title style
+    collectionTemplate: PropTypes.string,
+    // width of the slider
+    isFullWidth: PropTypes.bool,
+    // no of slides in slider
+    numberOfStoriesToShow: PropTypes.number,
+    // content alignment
+    contentAlignment: PropTypes.string,
+    footerButton: PropTypes.string,
+    collectionNameBorderColor: PropTypes.string
+  })
+};
+
+export default StateProvider(FullScreenSlider);

package/src/components/Rows/FullScreenSlider/stories.js

@@ -0,0 +1,115 @@
+import { color, boolean, number } from "@storybook/addon-knobs";
+import {
+  withStore,
+  optionalSelect,
+  sectionTagTemplates,
+  collectionNameTemplates,
+  footerButton
+} from "../../../../storybook";
+import FullScreenSlider from "./index";
+import { generateCollection } from "../../Fixture/";
+import { AdPlaceholder } from "../../Atoms/AdPlaceholder";
+import React from "react";
+import Readme from "./README.md";
+
+const collection = generateCollection({ stories: 8 });
+
+const label = "color";
+const defaultvalue = "#ffffff";
+
+const collectionNameDefaultValue = "#3a9fdd";
+const collectionNameBorderColorLabel = "Collection Name Border Color";
+
+const sectionTagBorderColor = "Section Tag Border Color";
+const sectionTagDefaultvalue = "#3a9fdd";
+
+const navigationStyle = {
+  defaultvalue: "none",
+  dots: "dots",
+  dashes: "dashes"
+};
+const contentAlignment = {
+  defaultvalue: "left",
+  center: "center"
+};
+
+const footerSlot = () => {
+  return <AdPlaceholder />;
+};
+
+withStore(
+  "Rows/Full Screen Slider ",
+  {
+    qt: {
+      config: {
+        "cdn-image": "thumbor-stg.assettype.com"
+      }
+    }
+  },
+  Readme
+).add("Default", () => {
+  const contextConfig = {
+    collectionNameBorderColor: color(collectionNameBorderColorLabel, collectionNameDefaultValue),
+    borderColor: color(sectionTagBorderColor, sectionTagDefaultvalue),
+    theme: color(label, defaultvalue),
+    collectionNameTemplate: optionalSelect("Collection Templates", collectionNameTemplates),
+    sectionTagTemplate: optionalSelect("Section Tag Templates", sectionTagTemplates),
+    showSection: boolean("section disable", true),
+    showAuthor: boolean("Author disable", true),
+    showRowTitle: boolean("Row Title disable", true),
+    showTime: boolean("Timestamp disable", true),
+    showSubheadline: boolean("subheadline enable ", false),
+    isFullWidth: boolean("isFullWidth", false),
+    numberOfStoriesToShow: number("Number of slide to show", 8),
+    isInfinite: boolean("Autoplay", false),
+    slideIndicator: optionalSelect("Slide Indicator", navigationStyle),
+    navigationArrows: boolean("Arrows enable", true),
+    contentAlignment: optionalSelect("content alignment", contentAlignment),
+    footerButton: optionalSelect("Footer Button", footerButton),
+    footerSlotConfig: { footerSlot: footerSlot },
+    showButton: boolean("Show button", true),
+    showReadTime: boolean("Read time", true)
+  };
+  return <FullScreenSlider collection={collection} config={contextConfig} />;
+});
+
+withStore(
+  "Rows/Full Screen Slider",
+  {
+    qt: {
+      config: {
+        "cdn-image": "thumbor-stg.assettype.com",
+        language: {
+          direction: "rtl"
+        }
+      }
+    }
+  },
+  Readme
+)
+  .addDecorator((story) => <div style={{ maxWidth: "1000px", margin: "auto", direction: "rtl" }}>{story()}</div>)
+  .add("Support Rtl ", () => {
+    const contextConfig = {
+      collectionNameBorderColor: color(collectionNameBorderColorLabel, collectionNameDefaultValue),
+      borderColor: color(sectionTagBorderColor, sectionTagDefaultvalue),
+      theme: color(label, defaultvalue),
+      collectionNameTemplate: optionalSelect("Collection Templates", collectionNameTemplates),
+      sectionTagTemplate: optionalSelect("Section Tag Templates", sectionTagTemplates),
+      showSection: boolean("section disable", true),
+      showAuthor: boolean("Author disable", true),
+      showRowTitle: boolean("Row Title disable", true),
+      showTime: boolean("Timestamp disable", true),
+      showSubheadline: boolean("subheadline enable ", false),
+      isFullWidth: boolean("isFullWidth", false),
+      numberOfStoriesToShow: number("Number of slide to show", 8),
+      isInfinite: boolean("Autoplay", false),
+      slideIndicator: optionalSelect("Slide Indicator", navigationStyle),
+      navigationArrows: boolean("Arrows enable", true),
+      contentAlignment: optionalSelect("content alignment", contentAlignment),
+      footerButton: optionalSelect("Footer Button", footerButton),
+      footerSlotConfig: { footerSlot: footerSlot },
+      showButton: boolean("Show button", true),
+      showReadTime: boolean("Read time", true)
+    };
+    return <FullScreenSlider collection={collection} config={contextConfig} />;
+  });

package/src/components/Rows/HalfScreenSlider/README.md

@@ -0,0 +1,43 @@
+# Half Screen Slider
+
+The _HalfScreenSlider_ component is a slider Row which shows 1 story at a time on desktop and mobile. It is a variation of the Full Screen Slider with a different story card.
+
+## Usage
+
+### Import
+
+```jsx
+import { HalfScreenSlider } from "@quintype/arrow";
+```
+
+### Setting the Row context
+
+```jsx
+const contextConfig = {
+  collectionNameBorderColor: color(collectionNameBorderColorLabel, collectionNameDefaultValue),
+  borderColor: color(sectionTagBorderColor, sectionTagDefaultvalue),
+  theme: color(label, defaultvalue),
+  border: optionalSelect("Border", borderTemplate),
+  showSection: boolean("section disable", true),
+  showAuthor: boolean("Author disable", true),
+  showTime: boolean("Timestamp disable", true),
+  showRowTitle: boolean("Row title", true),
+  footerButton: optionalSelect("Footer Button", footerButton),
+  collectionNameTemplate: optionalSelect("Collection row Templates", collectionNameTemplates),
+  sectionTagTemplate: optionalSelect("Section Tag Templates", sectionTagTemplates),
+  buttonText: text("Footer text"),
+  slideIndicator: optionalSelect("Slide Indicator", navigationStyle),
+  navigationArrows: boolean("Arrows enable", true),
+  isInfinite: boolean("Autoplay", false),
+  numberOfStoriesToShow: number("Number of slide to show", 3),
+  footerSlotConfig: { footerSlot: footerSlot },
+  showButton: boolean("Show button", true),
+  showReadTime: boolean("Read time", true)
+};
+```
+
+```jsx
+<HalfScreenSlider collection={collection} config={contextConfig} />
+```
+
+<!-- PROPS -->

package/src/components/Rows/HalfScreenSlider/half-screen-slider.m.css

@@ -0,0 +1,35 @@
+@custom-media --viewport-medium (width >= 768px);
+
+.half-screen-slider {
+  padding: var(--arrow-spacing-s) var(--arrow-spacing-s) 0;
+  @media (--viewport-medium) {
+    padding: 0;
+  }
+}
+.wrapper {
+  margin: var(--arrow-spacing-xs) 0;
+  @media (--viewport-medium) {
+    margin: var(--arrow-spacing-m) 0;
+  }
+}
+
+.border.dark {
+  border: 1px solid var(--dark-border);
+}
+
+.border.light {
+  border: 1px solid var(--light-border);
+}
+
+.half-screen-slider :global(.arr--content) {
+  padding-bottom: var(--arrow-spacing-m);
+  @media (--viewport-medium) {
+    padding-bottom: unset;
+  }
+}
+.half-screen-slider .border :global(.arr--content) {
+  padding: var(--arrow-spacing-m) var(--arrow-spacing-m) var(--arrow-spacing-xl) var(--arrow-spacing-m);
+  @media (--viewport-medium) {
+    padding: unset;
+  }
+}

package/src/components/Rows/HalfScreenSlider/index.js

@@ -0,0 +1,104 @@
+import React from "react";
+import PropTypes from "prop-types";
+import { useDispatch, useSelector } from "react-redux";
+import get from "lodash.get";
+
+import { collectionToStories } from "@quintype/components";
+import { CollectionName } from "../../Atoms/CollectionName";
+import { LoadmoreButton } from "../../Atoms/Loadmore";
+import { SliderHorizontalCard } from "../../Molecules/SliderHorizontalCard";
+import { StateProvider } from "../../SharedContext";
+import { getTextColor, getNumberOfStoriesToShow, generateNavigateSlug, navigateTo } from "../../../utils/utils";
+import { ScrollSnap } from "../../Atoms/ScrollSnap";
+
+import "./half-screen-slider.m.css";
+
+const HalfScreenSlider = ({ collection, config = {} }) => {
+  const {
+    collectionNameBorderColor = "",
+    borderColor = "",
+    theme = "",
+    border = "",
+    numberOfStoriesToShow = 1,
+    collectionNameTemplate,
+    footerButton = "",
+    footerSlotConfig = {},
+    navigationArrows = true,
+    slideIndicator = "none",
+    isInfinite = false
+  } = config;
+  const { footerSlot } = footerSlotConfig;
+  const items = collectionToStories(collection);
+  const textColor = getTextColor(theme);
+  const isBorderEnable = border === "full" ? "border" : "";
+  if (items.length < 1) {
+    return null;
+  }
+
+  const footerSlotComp = footerSlot ? footerSlot() : null;
+  const showNumberOfStoriesToShow = getNumberOfStoriesToShow(numberOfStoriesToShow);
+
+  const dispatch = useDispatch();
+  const qtConfig = useSelector((state) => get(state, ["qt", "config"], {}));
+  const url = generateNavigateSlug(collection, qtConfig);
+
+  return (
+    <div
+      className="full-width-with-padding arrow-component"
+      data-test-id="half-screen-slider"
+      style={{ backgroundColor: theme, color: textColor }}>
+      <div styleName="half-screen-slider">
+        <CollectionName
+          collection={collection}
+          collectionNameTemplate={collectionNameTemplate}
+          collectionNameBorderColor={collectionNameBorderColor}
+        />
+        <div styleName={`wrapper ${isBorderEnable} ${textColor}`}>
+          <ScrollSnap isArrow={navigationArrows} slideIndicator={slideIndicator} isInfinite={isInfinite}>
+            {items.slice(0, showNumberOfStoriesToShow).map((story, index) => {
+              return (
+                <SliderHorizontalCard
+                  headerLevel="2"
+                  key={index}
+                  story={story}
+                  isHorizontal
+                  borderColor={borderColor}
+                  config={config}
+                />
+              );
+            })}
+          </ScrollSnap>
+        </div>
+      </div>
+      <LoadmoreButton
+        template={footerButton}
+        collection={collection}
+        config={config}
+        navigate={() => navigateTo(dispatch, url)}
+        qtConfig={qtConfig}
+      />
+      {footerSlotComp}
+    </div>
+  );
+};
+export default StateProvider(HalfScreenSlider);
+HalfScreenSlider.propTypes = {
+  footerButton: PropTypes.string,
+  /**  collection is the array of objects which is returning by API  */
+  collection: PropTypes.object.isRequired,
+  // config is the configuration of the row
+  config: PropTypes.object.isRequired,
+  // border around the storycard
+  border: PropTypes.string,
+  // speed of the slider(ms)
+  autoplaySpeed: PropTypes.number,
+  // no of slides in slider
+  numberOfStoriesToShow: PropTypes.number,
+  // background and text color configuration
+  theme: PropTypes.string,
+  // style of the row title
+  collectionTemplate: PropTypes.string,
+  collectionNameBorderColor: PropTypes.string,
+  // section tag border color
+  borderColor: PropTypes.string
+};

package/src/components/Rows/HalfScreenSlider/stories.js

@@ -0,0 +1,115 @@
+import React from "react";
+import {
+  withStore,
+  optionalSelect,
+  sectionTagTemplates,
+  collectionNameTemplates,
+  footerButton
+} from "../../../../storybook";
+import { color, boolean, text, number } from "@storybook/addon-knobs";
+import HalfScreenSlider from "./index";
+import { AdPlaceholder } from "../../Atoms/AdPlaceholder";
+import { generateCollection } from "../../Fixture";
+import Readme from "./README.md";
+
+const collection = generateCollection({ stories: 8 });
+
+const label = "color";
+const defaultvalue = "#ffffff";
+
+const collectionNameDefaultValue = "#3a9fdd";
+const collectionNameBorderColorLabel = "Collection Name Border Color";
+
+const sectionTagBorderColor = "Section Tag Border Color";
+const sectionTagDefaultvalue = "#3a9fdd";
+
+const borderTemplate = {
+  default: " ",
+  border: "full"
+};
+
+const navigationStyle = {
+  defaultvalue: "none",
+  dots: "dots",
+  dashes: "dashes"
+};
+const footerSlot = () => {
+  return <AdPlaceholder />;
+};
+
+withStore(
+  "Rows/Half Screen Slider ",
+  {
+    qt: {
+      config: {
+        "cdn-image": "thumbor-stg.assettype.com"
+      }
+    }
+  },
+  Readme
+)
+  .addDecorator((story) => <div style={{ maxWidth: "1140px", margin: "auto" }}>{story()}</div>)
+  .add("Default", () => {
+    const contextConfig = {
+      collectionNameBorderColor: color(collectionNameBorderColorLabel, collectionNameDefaultValue),
+      borderColor: color(sectionTagBorderColor, sectionTagDefaultvalue),
+      theme: color(label, defaultvalue),
+      border: optionalSelect("Border", borderTemplate),
+      showSection: boolean("section disable", true),
+      showAuthor: boolean("Author disable", true),
+      showTime: boolean("Timestamp disable", true),
+      showRowTitle: boolean("Row title", true),
+      footerButton: optionalSelect("Footer Button", footerButton),
+      collectionNameTemplate: optionalSelect("Collection row Templates", collectionNameTemplates),
+      sectionTagTemplate: optionalSelect("Section Tag Templates", sectionTagTemplates),
+      buttonText: text("Footer text"),
+      slideIndicator: optionalSelect("Slide Indicator", navigationStyle),
+      navigationArrows: boolean("Arrows enable", true),
+      isInfinite: boolean("Autoplay", false),
+      numberOfStoriesToShow: number("Number of slide to show", 3),
+      footerSlotConfig: { footerSlot: footerSlot },
+      showButton: boolean("Show button", true),
+      showReadTime: boolean("Read time", true)
+    };
+    return <HalfScreenSlider collection={collection} config={contextConfig} />;
+  });
+
+withStore(
+  "Rows/Half Screen Slider",
+  {
+    qt: {
+      config: {
+        "cdn-image": "thumbor-stg.assettype.com",
+        language: {
+          direction: "rtl"
+        }
+      }
+    }
+  },
+  Readme
+)
+  .addDecorator((story) => <div style={{ maxWidth: "1000px", margin: "auto", direction: "rtl" }}>{story()}</div>)
+  .add("Support Rtl ", () => {
+    const contextConfig = {
+      collectionNameBorderColor: color(collectionNameBorderColorLabel, collectionNameDefaultValue),
+      borderColor: color(sectionTagBorderColor, sectionTagDefaultvalue),
+      theme: color(label, defaultvalue),
+      border: optionalSelect("Border", borderTemplate),
+      showSection: boolean("section disable", true),
+      showAuthor: boolean("Author disable", true),
+      showTime: boolean("Timestamp disable", true),
+      showRowTitle: boolean("Row title", true),
+      footerButton: optionalSelect("Footer Button", footerButton),
+      collectionNameTemplate: optionalSelect("Collection row Templates", collectionNameTemplates),
+      sectionTagTemplate: optionalSelect("Section Tag Templates", sectionTagTemplates),
+      buttonText: text("Footer text"),
+      slideIndicator: optionalSelect("Slide Indicator", navigationStyle),
+      navigationArrows: boolean("Arrows enable", true),
+      isInfinite: boolean("Autoplay", false),
+      numberOfStoriesToShow: number("Number of slide to show", 3),
+      footerSlotConfig: { footerSlot: footerSlot },
+      showButton: boolean("Show button", true),
+      showReadTime: boolean("Read time", true)
+    };
+    return <HalfScreenSlider collection={collection} config={contextConfig} />;
+  });

package/src/components/Rows/ListComponent/README.md

@@ -0,0 +1,48 @@
+# List Stories
+
+The _ListComponent_ component is a basic [row](https://bradfrost.com/blog/post/atomic-web-design/#organisms) with a list of storycards.
+
+## Usage
+
+### Import
+
+```jsx
+import { ListComponent } from "@quintype/arrow";
+```
+
+### Setting the Row context
+
+```jsx
+const contextConfig = {
+  theme: "#ffffff",
+  collectionNameTemplate: "default",
+  sectionTagTemplate: "default",
+  border: "bottom",
+  showSection: true,
+  showAuthor: true,
+  showTime: true,
+  showFooterButton: true,
+  buttonText: "Load More",
+  showRowTitle: true
+};
+```
+
+### Use as a component
+
+#### Default Usage
+
+```jsx
+<ListComponent story={story} />
+```
+
+#### ListComponent with border bottom
+
+```jsx
+<ListComponent story={story} border="bottom" />
+```
+
+#### ListComponent with full border
+
+```jsx
+<ListComponent story={story} border="full">
+```