@sproutsocial/racine 11.3.0-beta.1 → 11.3.0-beta.4

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change Log
 
+## 11.2.4
+
+### Patch Changes
+
+- 206bd32: copy updates to the TypeProps comments that power Seeds prop tables
+
+## 11.2.3
+
+### Patch Changes
+
+- 514d738: Patch badge component flow issue
+
+## 11.2.2
+
+### Patch Changes
+
+- 9cc377e: Created extended theme directory
+
+## 11.2.1
+
+### Patch Changes
+
+- 6968733: adds deprecation messaging to typeProps to be displayed on seeds page
+
+## 11.2.0
+
+### Minor Changes
+
+- a71a431: backwards compatible style and api changes to the badge component
+
 ## 11.1.2
 
 ### Patch Changes

package/__flow__/Badge/constants.js

@@ -0,0 +1,48 @@
+//@flow
+
+const defaultPurple = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.purple",
+};
+
+const suggestion = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue",
+};
+
+const passive = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.neutral",
+};
+
+const primary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue",
+};
+
+const secondary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.yellow",
+};
+
+const common = {
+  color: "colors.text.inverse",
+  background: "colors.aqua.600",
+};
+
+const approval = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.orange",
+};
+
+//Deprecated former "types"
+
+export const legacyBadgeColors = {
+  primary,
+  secondary,
+  passive,
+  common,
+  approval,
+  default: defaultPurple,
+  suggestion,
+};

package/__flow__/Badge/index.js

@@ -1,43 +1,70 @@
 // @flow
 import * as React from "react";
+import Icon from "../Icon";
 import Container from "./styles";
+import Box from "../Box";
 
 type TypeProps = {
-  text: React.Node,
-  type:
-    | "primary"
-    | "secondary"
-    | "passive"
-    | "common"
-    | "approval"
-    | "default"
-    | "suggestion",
-  size: "default" | "small",
+  children?: React.Node,
+  /** DEPRECATED: Use children instead of text */
+  text?: React.Node,
+  /** Size default is deprecated in favor of small and large */
+  size?: "small" | "large" | "default",
+  badgeColor?:
+    | "green"
+    | "blue"
+    | "purple"
+    | "yellow"
+    | "orange"
+    | "red"
+    | "neutral",
+  iconName?: string,
+  /** DEPRECATED: Possibly only used for testing. Refrain from using at all if possible. (optional) */
   tip?: React.Node,
+  /** DEPRECATED: The legacy method of choosing a theme. Use badgeColor instead. (optional) */
+  type?: string,
 };
 
-export default class Badge extends React.Component<TypeProps> {
-  static defaultProps = {
-    type: "primary",
-    size: "default",
-  };
-
-  render() {
-    const { size, type, tip, text, ...rest } = this.props;
-
-    return (
-      <Container
-        type={type}
-        small={size === "small"}
-        data-tip={tip}
-        data-qa-badge={text || ""}
-        data-qa-badge-type={type}
-        data-qa-badge-tip={tip || ""}
-        // $FlowIssue - upgrade v0.112.0
-        {...rest}
-      >
-        {text}
-      </Container>
+const Badge = ({
+  children,
+  text,
+  iconName,
+  type,
+  tip,
+  size = "small",
+  badgeColor = "blue",
+  ...rest
+}: TypeProps) => {
+  if (children && text) {
+    throw new Error(
+      "can't use both `children` and `text` props. Text is deprecated, consider using children."
     );
   }
-}
+
+  return (
+    <Container
+      {...rest}
+      // size previously included default, which currently maps to small.  Once consumers have updated this can be simplified.
+      size={size === "default" ? "large" : size}
+      badgeColor={badgeColor}
+      data-tip={tip}
+      data-qa-badge={text || ""}
+      data-qa-badge-type={type}
+      data-qa-badge-tip={tip || ""}
+      type={type && type}
+    >
+      <Box display="flex" alignItems="center" JustifyContent="center">
+        {iconName ? (
+          <Icon
+            mr={200}
+            name={iconName}
+            size={size === "small" ? "mini" : "default"}
+          />
+        ) : null}
+        {children || text}
+      </Box>
+    </Container>
+  );
+};
+
+export default Badge;

package/__flow__/Badge/index.stories.js

@@ -1,53 +1,46 @@
 import React from "react";
-import { text } from "@storybook/addon-knobs";
 import Badge from "./index";
+import Box from "../Box";
+import Numeral from "../Numeral";
+import Text from "../Text";
+import Stack from "../Stack";
 
 export default {
   title: "Badge",
 };
 
 export const permutations = () => (
-  <>
-    <Badge
-      text={text("text", "Test")}
-      type="default"
-      size={text("size", "small")}
-    />
-    <Badge text={text("text", "Test")} size={text("size", "small")} />
-    <Badge
-      text={text("text", "Test")}
-      type="secondary"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="passive"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="common"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="approval"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="suggestion"
-      size={text("size", "small")}
-    />
-
-    <Badge text={text("text", "Test")} type="default" />
-    <Badge text={text("text", "Test")} />
-    <Badge text={text("text", "Test")} type="secondary" />
-    <Badge text={text("text", "Test")} type="passive" />
-    <Badge text={text("text", "Test")} type="common" />
-    <Badge text={text("text", "Test")} type="approval" />
-    <Badge text={text("text", "Test")} type="suggestion" />
-  </>
+  <Stack space={450}>
+    <Box display="flex" alignItems="center">
+      <Badge badgeColor="green">Badge</Badge>
+      <Badge>Badge</Badge>
+      <Badge badgeColor="purple">Badge</Badge>
+      <Badge badgeColor="yellow">Badge</Badge>
+      <Badge badgeColor="orange">Badge</Badge>
+      <Badge badgeColor="red">Badge</Badge>
+      <Badge badgeColor="neutral" iconName="atom">
+        Badge
+      </Badge>
+      <Badge
+        size="small"
+        type="default"
+        bg="chartreuse"
+        color="crimson"
+        p={500}
+      >
+        Radical overrides!
+      </Badge>
+    </Box>
+    <Box display="flex" alignItems="center">
+      <Badge size="large" type="secondary" iconName="sparkles">
+        Supports legacy types
+      </Badge>
+      <Badge size="large">
+        <Numeral fontWeight="bold" number={1569241} />
+        <Text ml={200}>and children!</Text>
+      </Badge>
+    </Box>
+  </Stack>
 );
 
 permutations.story = {

package/__flow__/Badge/index.test.js

@@ -3,48 +3,50 @@ import Badge from "./";
 import { render } from "../utils/react-testing-library";
 import "jest-styled-components";
 
-describe("Racine Badge", () => {
-  it("should render with default props", () => {
-    const { getByText, getByDataQaLabel } = render(<Badge text="Test" />);
+describe("Badge...", () => {
+  it("...should render with default props", () => {
+    const { getByText } = render(<Badge>Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "primary" })).toBeTruthy();
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "padding",
+      "0px 4px"
+    );
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#dcf2ff"
+    );
   });
 
-  it("should render with correct size styling", () => {
-    const { getByText } = render(<Badge text="Test" size="small" />);
-    expect(getByText("Test")).toHaveStyleRule("padding", "4px 8px");
+  it("...should render with correct size styling", () => {
+    const { getByText } = render(<Badge size="large">Test</Badge>);
+    expect(getByText("Test").closest("span")).toHaveStyleRule("padding", "8px");
   });
 
-  it("should render with secondary type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="secondary" />
-    );
+  it("...should render with legacy type", () => {
+    const { getByText } = render(<Badge type="secondary">Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "secondary" })).toBeTruthy();
-  });
-
-  it("should render with passive type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="passive" />
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "color",
+      "#364141"
+    );
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#fdefcd"
     );
-    expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "passive" })).toBeTruthy();
   });
 
-  it("should render with common type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="common" />
-    );
+  it("...should render with a badge color", () => {
+    const { getByText } = render(<Badge badgeColor="purple">Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "common" })).toBeTruthy();
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#eaeaf9"
+    );
   });
 
-  it("should render with approval type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="approval" />
-    );
-    expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "approval" })).toBeTruthy();
+  it("...should render with an icon", () => {
+    const { container } = render(<Badge iconName="sparkles">Test</Badge>);
+    expect(container.querySelector("svg")).toBeTruthy();
   });
   it("should render with suggestion type", () => {
     const { getByText, getByDataQaLabel } = render(
@@ -54,9 +56,9 @@ describe("Racine Badge", () => {
     expect(getByDataQaLabel({ "badge-type": "suggestion" })).toBeTruthy();
   });
 
-  it("should render with tooltip class", () => {
+  it("...should render with tooltip class", () => {
     const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" tip="test tip" />
+      <Badge tip="test tip">Test</Badge>
     );
     expect(getByText("Test")).toBeTruthy();
     expect(getByDataQaLabel({ "badge-tip": "test tip" })).toBeTruthy();

package/__flow__/Badge/styles.js

@@ -1,51 +1,31 @@
 //@flow
-import styled, { css, type StyledComponent } from "styled-components";
+import styled, { type StyledComponent } from "styled-components";
 import { COMMON } from "../utils/system-props";
-import { themeGet } from "@styled-system/theme-get";
-
 import type { TypeTheme } from "../types/theme.flow";
-
-const colors = {
-  primary: "colors.neutral.0",
-  secondary: "colors.neutral.800",
-  passive: "colors.neutral.800",
-  common: "colors.neutral.0",
-  approval: "colors.neutral.800",
-  default: "colors.neutral.0",
-  suggestion: "colors.neutral.900",
-};
-
-const backgroundColors = {
-  primary: "colors.blue.700",
-  secondary: "colors.yellow.500",
-  passive: "colors.neutral.200",
-  common: "colors.aqua.600",
-  approval: "colors.orange.300",
-  default: "colors.purple.700",
-  suggestion: "colors.blue.300",
-};
+import { themeGet } from "@styled-system/theme-get";
+import { legacyBadgeColors } from "./constants";
 
 // eslint-disable-next-line prettier/prettier
-const Container: StyledComponent<{type: "primary" | "secondary" | "passive" | "common" | "approval" | "default" | "suggestion", small: boolean, ...}, TypeTheme, *> = styled.span`
+const Container: StyledComponent<{type: ?string, badgeColor: string, size: string, ...}, TypeTheme, *> = styled.span`
+  font-family: ${(p) => p.theme.fontFamily};
+  ${(p) =>
+    p.size === "small" ? p.theme.typography[100] : p.theme.typography[200]};
+  border-radius: 9999px;
+  line-height: 16px;
   display: inline-block;
-  text-align: center;
-  border-radius: 50px;
-  font-family: ${(props) => props.theme.fontFamily};
-
-  padding: ${(props) =>
-    props.small
-      ? `${props.theme.space[200]} ${props.theme.space[300]}`
-      : `${props.theme.space[300]} ${props.theme.space[350]}`};
-
-  ${(props) =>
-    props.small ? props.theme.typography[100] : props.theme.typography[200]}
-
-  ${(props) => css`
-    color: ${themeGet(colors[props.type])(props)};
-    background: ${themeGet(backgroundColors[props.type])(props)};
-  `}
-
-  ${COMMON}
+  color: ${(p) =>
+    p.type
+      ? themeGet(legacyBadgeColors[p.type].color)
+      : p.theme.colors.text.body};
+  background: ${(p) =>
+    p.type
+      ? themeGet(legacyBadgeColors[p.type].background)
+      : p.theme.colors.container.background.decorative[p.badgeColor]};
+  padding: ${(p) =>
+    p.size === "small"
+      ? `${p.theme.space[0]} ${p.theme.space[200]}`
+      : `${p.theme.space[300]}`};
+  ${COMMON};
 `;
 
 export default Container;

package/__flow__/Input/index.js

@@ -72,21 +72,48 @@ type TypeProps = {
 type TypeInputContext = $Shape<{
   handleClear: (e: SyntheticEvent<HTMLButtonElement>) => void,
   clearButtonLabel: string,
+  hasValue: boolean,
 }>;
 
 const InputContext = React.createContext<TypeInputContext>({});
 
 const ClearButton = () => {
-  const { handleClear, clearButtonLabel } = React.useContext(InputContext);
+  const { handleClear, clearButtonLabel, hasValue, size } =
+    React.useContext(InputContext);
+
+  // Hide the button when there is no text to clear.
+  if (!hasValue) {
+    return null;
+  }
+
+  // Cut down the padding for size small Inputs so that the focus ring won't go outside the bounds of the Input.
+  // This adjustment is handled automatically for default and large Inputs via Button's size. There is no "small" Button.
+  const py = size === "small" ? 100 : undefined;
+  const px = size === "small" ? 200 : undefined;
+  const buttonSize = size === "small" ? "default" : size;
+
+  // Warn if clearButtonLabel is not included, so that the unlocalized fallback will not be mistaken for a proper label.
+  if (!clearButtonLabel) {
+    console.warn(
+      "Warning: clearButtonLabel prop is required when using Input.ClearButton. Please pass a localized label to Input."
+    );
+  }
   return (
-    <Button onClick={handleClear}>
-      {/*Unlocalized fallback should not be used. Always include a localized
-      clearButtonLabel when using <Input.ClearButton/> or <Input type="search"/>.*/}
+    <Button onClick={handleClear} size={buttonSize} py={py} px={px}>
       <Icon name="circlex" title={clearButtonLabel || "Clear"} />
     </Button>
   );
 };
 
+// Used for positioning elementAfter. This logic will detect if the element is a ClearButton,
+// regardless of whether it was manually passed as elemAfter or automatically added to a search Input.
+const isClearButton = (elem: any) => {
+  if (elem?.type) {
+    return elem.type.displayName === "Input.ClearButton";
+  }
+  return false;
+};
+
 class Input extends React.Component<TypeProps> {
   static defaultProps = {
     autoFocus: false,
@@ -101,8 +128,10 @@ class Input extends React.Component<TypeProps> {
   handleBlur = (e: SyntheticFocusEvent<HTMLInputElement>) =>
     this.props.onBlur?.(e);
 
-  handleClear = (e: SyntheticEvent<HTMLButtonElement>) =>
+  handleClear = (e: SyntheticEvent<HTMLButtonElement>) => {
     this.props.onClear?.(e);
+    this.props.innerRef?.current?.focus();
+  };
 
   handleChange = (e: SyntheticInputEvent<HTMLInputElement>) =>
     this.props.onChange?.(e, e.currentTarget.value);
@@ -150,6 +179,7 @@ class Input extends React.Component<TypeProps> {
       inputProps = {},
       qa = {},
       appearance,
+      size,
       ...rest
     } = this.props;
 
@@ -162,7 +192,7 @@ class Input extends React.Component<TypeProps> {
     // Add default elemBefore and elemAfter elements if type is search.
     const elementBefore =
       type === "search" && !elemBefore ? (
-        <Icon name="search" ariaHidden />
+        <Icon name="search" ariaHidden color="icon.base" />
       ) : (
         elemBefore
       );
@@ -178,13 +208,16 @@ class Input extends React.Component<TypeProps> {
         invalid={!!isInvalid}
         warning={hasWarning}
         appearance={appearance}
+        size={size}
         // $FlowIssue - upgrade v0.112.0
         {...rest}
       >
         <InputContext.Provider
           value={{
             handleClear: this.handleClear,
+            hasValue: !!value,
             clearButtonLabel,
+            size,
           }}
         >
           {elementBefore && <Accessory before>{elementBefore}</Accessory>}
@@ -219,14 +252,7 @@ class Input extends React.Component<TypeProps> {
           />
 
           {elementAfter && (
-            <Accessory
-              after
-              // Used for positioning. This logic will detect if the element is a ClearButton,
-              // regardless of whether it was manually passed as elemAfter or automatically added to a search Input.
-              isClearButton={
-                elementAfter?.type?.prototype === Input.ClearButton.prototype
-              }
-            >
+            <Accessory after isClearButton={isClearButton(elementAfter)}>
               {elementAfter}
             </Accessory>
           )}

package/__flow__/Input/index.stories.js

@@ -156,6 +156,38 @@ searchInput.story = {
   name: "Search Input",
 };
 
+export const smallSearchInput = () => (
+  <Input
+    type="search"
+    size="small"
+    placeholder={text("placeholder", "Please enter a value...")}
+    value={text("value", "val")}
+    onClear={() => window.alert("Cleared!")}
+    clearButtonLabel={text("clearButtonLabel", "Clear search")}
+    ariaLabel={text("ariaLabel", "Descriptive label goes here")}
+  />
+);
+
+smallSearchInput.story = {
+  name: "Small Search Input",
+};
+
+export const largeSearchInput = () => (
+  <Input
+    type="search"
+    size="large"
+    placeholder={text("placeholder", "Please enter a value...")}
+    value={text("value", "val")}
+    onClear={() => window.alert("Cleared!")}
+    clearButtonLabel={text("clearButtonLabel", "Clear search")}
+    ariaLabel={text("ariaLabel", "Descriptive label goes here")}
+  />
+);
+
+largeSearchInput.story = {
+  name: "Large Search Input",
+};
+
 export const nonSearchClearButtonInput = () => {
   return (
     <Input
@@ -171,7 +203,7 @@ export const nonSearchClearButtonInput = () => {
 };
 
 nonSearchClearButtonInput.story = {
-  name: "Input.ClearButton usage",
+  name: "Manual Input.ClearButton usage",
 };
 
 export const autofocus = () => (

package/__flow__/Input/index.test.js

@@ -85,6 +85,20 @@ describe("Input", () => {
         expect(getByRole("button")).toBeTruthy();
       });
 
+      it("should not render a clear button for search Inputs if there is no text", () => {
+        const { queryByRole } = render(
+          <Input
+            id="name"
+            name="name"
+            value=""
+            type="search"
+            onClear={jest.fn()}
+            clearButtonLabel="Clear search"
+          />
+        );
+        expect(queryByRole("button")).toBeFalsy();
+      });
+
       it("should not override an elemAfter prop if passed", () => {
         const { getByText, queryByTitle } = render(
           <Input
@@ -189,6 +203,20 @@ describe("Input", () => {
         expect(getByRole("button")).toBeTruthy();
       });
 
+      it("should not render a clear button if there is no text", () => {
+        const { queryByRole } = render(
+          <Input
+            id="name"
+            name="name"
+            value=""
+            type="text"
+            elemAfter={<Input.ClearButton />}
+            clearButtonLabel="Clear search"
+          />
+        );
+        expect(queryByRole("button")).toBeFalsy();
+      });
+
       it("should use the fallback title if clearButtonLabel is not provided", () => {
         const { getByTitle } = render(
           <Input

package/__flow__/Link/index.js

@@ -8,10 +8,11 @@ type TypeProps = {
   /** Optional prop to make the URL open in a new tab */
   external?: boolean,
   children: React.Node,
+  /** Setting this prop will cause the component to be rendered as a link */
   href?: string,
   /** Disables user action and applies a disabled style to the component */
   disabled?: boolean,
-  /** Setting this prop will cause the component to be rendered as a button instead of an anchor) */
+  /** Can be used in addition to an href but still renders as a link. Omitting href will render as button */
   onClick?: (e: SyntheticEvent<HTMLButtonElement>) => void,
   as?: $PropertyType<TypeStyledComponentsCommonProps, "as">,
   underline?: boolean,

package/__flow__/themes/extendedThemes/README.md

@@ -0,0 +1,6 @@
+## Extended Theme Directory
+
+This directory serves as a shared environment for all extended themes. Each unique theme should have its own folder and theme.js file.
+`src/themes/extendedThemes/customTheme/theme.js`
+
+Check out our documentation for [How to extend the theme](https://seeds.sproutsocial.com/components/theme#extending-the-theme) on Seeds.