@sproutsocial/racine 11.6.0 → 11.6.1-input-beta.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 11.6.1
+
+### Patch Changes
+
+- eb27d01: Fix interact util in dark mode themes
+  - The `interact` util was located at a different location in the light and dark mode base theme objects. It was at the base level of the light theme and nested inside of `colors` for the dark theme.
+  - `interact` was seemingly available at the base level of the theme in both modes, because we spread the light theme as the basis of the dark theme. However, the `interact` util accessible at the base level of the theme would behave like light mode in either mode.
+  - The `interact` util located inside the `colors` object inside the dark mode theme object was not usable, due to only being defined in that location for dark mode, and has been removed.
+- eb27d01: Remove 'just-clone' dependency
+- eb27d01: Fix "navigation" colors in SproutTheme
+  - The "navigation" colors were not available in the theme due to being spread in incorrectly.
+- eb27d01: Improve theme types to be more accurate
+
 ## 11.6.0
 
 ### Minor Changes

package/__flow__/Checkbox/styles.js

@@ -182,90 +182,90 @@ const getIcon = (type, color) => {
 
 // eslint-disable-next-line prettier/prettier
 export const CheckboxContainer: StyledComponent<any, TypeTheme, *> = styled.span(
-    (props) => css`
-      display: inline-flex;
-      align-items: center;
-      box-sizing: border-box;
-      position: relative;
-      transition: all ${props.theme.duration.fast} ${props.theme.easing.ease_in};
-
-      @supports (-webkit-appearance: none) {
-        &:before {
-          /* stylelint-disable */
-          content: url("data:image/svg+xml;utf8,${getIcon(
-            props.indeterminate ? "indeterminate" : "check",
-
-            props.checked
-              ? props.theme.colors.form.background.base
-              : props.theme.colors.form.border.base
-          )}");
-          opacity: ${props.checked ? 1 : 0};
-          position: absolute;
-          width: ${props.theme.space[400]};
-          height: ${props.theme.space[400]};
-          text-align: center;
-          transform: translateY(1px);
-          line-height: 1;
-          margin: auto;
-          pointer-events: none;
-          transition: ${props.theme.duration.fast}
-            ${props.theme.easing.ease_inout};
+  (props) => css`
+    display: inline-flex;
+    align-items: center;
+    box-sizing: border-box;
+    position: relative;
+    transition: all ${props.theme.duration.fast} ${props.theme.easing.ease_in};
+
+    @supports (-webkit-appearance: none) {
+      &:before {
+        /* stylelint-disable */
+        content: url("data:image/svg+xml;utf8,${getIcon(
+          props.indeterminate ? "indeterminate" : "check",
+
+          props.checked
+            ? props.theme.colors.form.background.base
+            : props.theme.colors.form.border.base
+        )}");
+        opacity: ${props.checked ? 1 : 0};
+        position: absolute;
+        width: ${props.theme.space[400]};
+        height: ${props.theme.space[400]};
+        text-align: center;
+        transform: translateY(1px);
+        line-height: 1;
+        margin: auto;
+        pointer-events: none;
+        transition: ${props.theme.duration.fast}
+          ${props.theme.easing.ease_inout};
+      }
+
+      &:hover:before {
+        opacity: ${props.disabled && !props.checked ? 0 : 1};
+      }
+
+      ${props.disabled &&
+      css`
+        opacity: 0.4;
+      `}
+
+      input[type='checkbox'] {
+        box-sizing: border-box;
+        appearance: none;
+        margin: 0;
+        padding: 0;
+        width: ${props.theme.space[400]};
+        height: ${props.theme.space[400]};
+        border: 1px solid ${props.theme.colors.form.border.base};
+        border-radius: 4px;
+        background-color: ${props.theme.colors.form.background.base};
+        transition: all ${props.theme.duration.fast}
+          ${props.theme.easing.ease_in};
+        cursor: ${props.disabled ? "not-allowed" : "pointer"};
+        flex-shrink: 0;
+
+        &:not(:checked) {
+          ${!props.indeterminate &&
+          css`
+            border-color: ${props.theme.colors
+              .neutral[300]} !important; /* We don't want the focus ring to remove the border */
+            background-color: ${props.theme.colors.form.background.base};
+          `}
         }
 
-        &:hover:before {
-          opacity: ${props.disabled && !props.checked ? 0 : 1};
+        &:checked {
+          border-color: ${props.theme.colors.form.border.selected};
+          background-color: ${props.theme.colors.form.background.selected};
         }
 
-        ${props.disabled &&
+        ${props.indeterminate &&
+        props.checked &&
         css`
-          opacity: 0.4;
+          border-color: ${props.theme.colors.form.border.selected} !important;
+          background-color: ${props.theme.colors.form.background
+            .selected} !important;
         `}
 
-        input[type='checkbox'] {
-          box-sizing: border-box;
-          appearance: none;
-          margin: 0;
-          padding: 0;
-          width: ${props.theme.space[400]};
-          height: ${props.theme.space[400]};
-          border: 1px solid ${props.theme.colors.form.border.base};
-          border-radius: 4px;
-          background-color: ${props.theme.colors.form.background.base};
-          transition: all ${props.theme.duration.fast}
-            ${props.theme.easing.ease_in};
-          cursor: ${props.disabled ? "not-allowed" : "pointer"};
-          flex-shrink: 0;
-
-          &:not(:checked) {
-            ${!props.indeterminate &&
-            css`
-              border-color: ${props.theme.colors
-                .neutral[300]} !important; /* We don't want the focus ring to remove the border */
-              background-color: ${props.theme.colors.form.background.base};
-            `}
-          }
-
-          &:checked {
-            border-color: ${props.theme.colors.form.border.selected};
-            background-color: ${props.theme.colors.form.background.selected};
-          }
-
-          ${props.indeterminate &&
-          props.checked &&
-          css`
-            border-color: ${props.theme.colors.form.border.selected} !important;
-            background-color: ${props.theme.colors.form.background
-              .selected} !important;
-          `}
-
-          &:focus {
-            ${focusRing}
-          }
+        &:focus {
+          ${focusRing}
         }
       }
+    }
 
-      ${COMMON}
-    `
-  );
+    ${COMMON}
+  `
+);
 
 export default Container;

package/__flow__/Collapsible/index.js

@@ -73,8 +73,9 @@ const Trigger = ({ children, ...rest }) => {
 };
 
 const Panel = ({ children, ...rest }) => {
-  const { isOpen, id, offset, collapsedHeight, openHeight } =
-    useContext(CollapsibleContext);
+  const { isOpen, id, offset, collapsedHeight, openHeight } = useContext(
+    CollapsibleContext
+  );
   const ref = useRef();
   const measurement = useMeasure(ref);
   const [isHidden, setIsHidden] = useState(undefined);

package/__flow__/Image/index.js

@@ -80,8 +80,16 @@ export default class Image extends React.Component<TypeProps, TypeState> {
   };
 
   render() {
-    const { alt, title, onClick, onError, onLoad, src, qa, ...rest } =
-      this.props;
+    const {
+      alt,
+      title,
+      onClick,
+      onError,
+      onLoad,
+      src,
+      qa,
+      ...rest
+    } = this.props;
 
     return (
       <ImageContainer

package/__flow__/Input/index.js

@@ -16,7 +16,7 @@ type TypeProps = {
   ariaLabel?: string,
   /** Attribute used to associate other elements that describe the Input, like an error */
   ariaDescribedby?: string,
-  /** Label for Input.ClearButton. Required when using <Input type="search"/> or <Input.ClearButton/>. */
+  /** Label for Input.ClearButton. Required when using Input.ClearButton. */
   clearButtonLabel?: string,
   /** Placeholder text for when value is undefined or empty */
   placeholder?: string,
@@ -52,8 +52,9 @@ type TypeProps = {
     | ((React.ElementRef<any> | HTMLElement) => void),
   onBlur?: (e: SyntheticFocusEvent<HTMLInputElement>) => void,
   onChange?: (e: SyntheticInputEvent<HTMLInputElement>, value: string) => void,
-  /** Input.ClearButton onClick callback. Required when using <Input type="search"/> or <Input.ClearButton/>.
-   The component handles returning focus to Input after onClear is called only. You must reset "value" yourself.*/
+  /** Input.ClearButton onClick callback. Required when using Input.ClearButton.
+   The component handles returning focus to Input after onClear is called.
+   For controlled Inputs, you must reset "value" yourself.*/
   onClear?: (e: SyntheticEvent<HTMLButtonElement>) => void,
   onFocus?: (e: SyntheticFocusEvent<HTMLInputElement>) => void,
   onKeyDown?: (
@@ -74,12 +75,17 @@ type TypeProps = {
   appearance?: "primary" | "secondary",
 };
 
+type TypeState = {
+  hasValue: boolean,
+};
+
 // Using Context so that Input's Input.ClearButton-specific props can be passed to Input.ClearButton,
 // regardless of whether it is manually included as elemAfter or automatically included for type="search" Inputs.
 type TypeInputContext = $Shape<{
   onClear?: (e: SyntheticEvent<HTMLButtonElement>) => void,
   handleClear: (e: SyntheticEvent<HTMLButtonElement>) => void,
   clearButtonLabel: string,
+  isControlled: boolean,
   hasValue: boolean,
   size: "large" | "small" | "default",
 }>;
@@ -99,6 +105,7 @@ const ClearButton = () => {
     onClear,
     handleClear,
     clearButtonLabel,
+    isControlled,
     hasValue,
     size: inputSize,
   } = React.useContext(InputContext);
@@ -108,12 +115,9 @@ const ClearButton = () => {
     return null;
   }
 
-  // Log a warning and hide the button when no onClear callback is provided.
-  // If we called handleClear with no onClear prop, all the button would do is focus the Input.
-  if (!onClear) {
-    console.warn(
-      "Warning: No onClear prop provided to Input when using Input.ClearButton. Omitting Input.ClearButton."
-    );
+  // Hide the button when no onClear callback is provided to a controlled Input.
+  // For a controlled component, all the button would do without an onClear is focus the input.
+  if (isControlled && !onClear) {
     return null;
   }
 
@@ -154,7 +158,16 @@ const isClearButton = (elem: any) => {
   return false;
 };
 
-class Input extends React.Component<TypeProps> {
+class Input extends React.Component<TypeProps, TypeState> {
+  constructor(props: TypeProps) {
+    super(props);
+    this.state = {
+      // Tracking hasValue in state allows us to hide ClearButton when there is no value to clear
+      // for both controlled and uncontrolled inputs.
+      hasValue: !!props.value,
+    };
+  }
+
   static defaultProps = {
     autoFocus: false,
     disabled: false,
@@ -165,7 +178,7 @@ class Input extends React.Component<TypeProps> {
 
   static ClearButton = ClearButton;
 
-  // Define our own ref for focus management.
+  // Define our own ref for use in handleClear.
   // We use mergeRefs to pass both this.inputRef and this.props.innerRef to input.
   inputRef = React.createRef<HTMLInputElement>();
 
@@ -173,12 +186,21 @@ class Input extends React.Component<TypeProps> {
     this.props.onBlur?.(e);
 
   handleClear = (e: SyntheticEvent<HTMLButtonElement>) => {
-    this.inputRef?.current?.focus();
+    // If the component is uncontrolled, clear its value via ref.
+    if (typeof this.props.value !== "string") {
+      if (this.inputRef.current) {
+        this.inputRef.current.value = "";
+      }
+    }
+    this.inputRef.current?.focus();
     this.props.onClear?.(e);
+    this.updateState("");
   };
 
-  handleChange = (e: SyntheticInputEvent<HTMLInputElement>) =>
+  handleChange = (e: SyntheticInputEvent<HTMLInputElement>) => {
     this.props.onChange?.(e, e.currentTarget.value);
+    this.updateState(e.currentTarget.value);
+  };
 
   handleFocus = (e: SyntheticFocusEvent<HTMLInputElement>) =>
     this.props.onFocus?.(e);
@@ -192,6 +214,15 @@ class Input extends React.Component<TypeProps> {
   handlePaste = (e: SyntheticInputEvent<HTMLInputElement>) =>
     this.props.onPaste?.(e, e.currentTarget.value);
 
+  updateState = (value: string) => {
+    const hasValue = value !== "";
+    const hadValue = this.state.hasValue;
+    // Only update state if the value has changed to avoid unnecessary renders.
+    if (hasValue !== hadValue) {
+      this.setState({ hasValue });
+    }
+  };
+
   render() {
     const {
       autoComplete,
@@ -240,9 +271,9 @@ class Input extends React.Component<TypeProps> {
       ) : (
         elemBefore
       );
-    // Do not add a ClearButton if no onClear callback is provided or if an elemAfter prop was passed.
+    // Do not add a ClearButton if an elemAfter prop was passed.
     const elementAfter =
-      type === "search" && onClear && !elemAfter ? <ClearButton /> : elemAfter;
+      type === "search" && !elemAfter ? <ClearButton /> : elemAfter;
 
     return (
       <Container
@@ -259,7 +290,8 @@ class Input extends React.Component<TypeProps> {
         <InputContext.Provider
           value={{
             handleClear: this.handleClear,
-            hasValue: !!value,
+            hasValue: this.state.hasValue,
+            isControlled: typeof this.props.value === "string",
             clearButtonLabel,
             onClear,
             size,

package/__flow__/Input/index.stories.js

@@ -188,6 +188,20 @@ largeSearchInput.story = {
   name: "Large Search Input",
 };
 
+export const uncontrolledSearchInput = () => (
+  <Input
+    type="search"
+    placeholder={text("placeholder", "Please enter a value...")}
+    onClear={() => window.alert("Cleared!")}
+    clearButtonLabel={text("clearButtonLabel", "Clear search")}
+    ariaLabel={text("ariaLabel", "Descriptive label goes here")}
+  />
+);
+
+uncontrolledSearchInput.story = {
+  name: "Uncontrolled Search Input",
+};
+
 export const nonSearchClearButtonInput = () => {
   return (
     <Input

package/__flow__/Input/index.test.js

@@ -85,6 +85,24 @@ describe("Input", () => {
         expect(getByRole("button")).toBeTruthy();
       });
 
+      it("should render a clear button for an uncontrolled search Input only once it is typed in", () => {
+        const { getByRole, queryByRole } = render(
+          <Input
+            id="name"
+            name="name"
+            type="search"
+            onClear={jest.fn()}
+            clearButtonLabel="Clear search"
+          />
+        );
+        expect(queryByRole("button")).toBeFalsy();
+        const input = getByRole("searchbox");
+        userEvent.tab();
+        expect(input).toHaveFocus();
+        userEvent.keyboard("some text");
+        expect(getByRole("button")).toBeTruthy();
+      });
+
       it("should not render a clear button for search Inputs if there is no text", () => {
         const { queryByRole } = render(
           <Input

package/__flow__/Input/styles.js

@@ -134,13 +134,13 @@ export const Accessory: StyledComponent<any, TypeTheme, *> = styled.div`
   ${(props) =>
     props.before &&
     css`
-      left: ${props.theme.space[350]};
+      left: ${props.theme.space[300]};
     `};
 
   ${(props) =>
     props.after &&
     css`
-      right: ${props.isClearButton ? 0 : props.theme.space[350]};
+      right: ${props.isClearButton ? 0 : props.theme.space[300]};
     `};
 `;
 

package/__flow__/SegmentedControl/index.js

@@ -17,8 +17,9 @@ type TypeSegmentedControlContext = {
   onChange: (e: SyntheticInputEvent<HTMLInputElement>) => void,
 };
 
-const SegmentedControlContext =
-  React.createContext<?TypeSegmentedControlContext>(null);
+const SegmentedControlContext = React.createContext<?TypeSegmentedControlContext>(
+  null
+);
 
 type TypeSegmentedControlItemProps = {
   /** The value of this item. Should be unique among sibling items. */

package/__flow__/TableCell/index.js

@@ -22,8 +22,15 @@ export type TypeTableCell = {
  */
 export default class TableCell extends React.Component<TypeTableCell> {
   render() {
-    const { id, content, colSpan, width, align, children, ...rest } =
-      this.props;
+    const {
+      id,
+      content,
+      colSpan,
+      width,
+      align,
+      children,
+      ...rest
+    } = this.props;
 
     return (
       <Container

package/__flow__/ThemeProvider/index.js

@@ -3,8 +3,7 @@ import * as React from "react";
 import { ThemeProvider as BaseThemeProvider } from "styled-components";
 import theme from "../themes/light/theme";
 
-import type { TypeTheme } from "../types/theme.flow";
-import type { TypeSproutTheme } from "../themes/extendedThemes/sproutTheme/sproutThemeType.flow";
+import type { TypeTheme, TypeSproutTheme } from "../types/theme.flow";
 
 // We can append additional themes types here
 type TypeAllThemes = TypeTheme | TypeSproutTheme;

package/__flow__/ToggleHint/index.js

@@ -32,8 +32,15 @@ export default class ToggleHint extends React.Component<TypeProps> {
   };
 
   render() {
-    const { icon, isOpen, openString, closeString, qa, className, ...rest } =
-      this.props;
+    const {
+      icon,
+      isOpen,
+      openString,
+      closeString,
+      qa,
+      className,
+      ...rest
+    } = this.props;
 
     return (
       <Container

package/__flow__/index.js

@@ -1,6 +1,6 @@
 // @flow
 export type { EnumIconNames } from "./EnumIconNames";
-export type { TypeTheme } from "./types/theme.flow";
+export type { TypeTheme, TypeSproutTheme } from "./types/theme.flow";
 export * from "./systemProps";
 export { visuallyHidden, focusRing, disabled } from "./utils/mixins";
 export { useSelect, useMultiselect, useTextContent } from "./utils/hooks";
@@ -10,7 +10,6 @@ export {
   sproutLightTheme,
   sproutDarkTheme,
 } from "./themes/extendedThemes/sproutTheme";
-export type { TypeSproutTheme } from "./themes/extendedThemes/sproutTheme";
 export { default as Icon } from "./Icon";
 // DEPRECATED: Alert has been renamed to Banner
 export { default as Alert } from "./Banner";

package/__flow__/systemProps/color.js

@@ -14,8 +14,7 @@ import type {
 
 // https://styled-system.com/table#color
 
-type TypeBackgroundColorSystemProp =
-  TypeResponsiveBaseSystemProp<BackgroundColorProperty>;
+type TypeBackgroundColorSystemProp = TypeResponsiveBaseSystemProp<BackgroundColorProperty>;
 export type TypeColorSystemProps = $ReadOnly<{|
   backgroundColor?: TypeBackgroundColorSystemProp,
   bg?: TypeBackgroundColorSystemProp,

package/__flow__/themes/dark/theme.js

@@ -29,9 +29,6 @@ export const shadows = {
 
 const colors = {
   ...lightTheme.colors,
-  utils: {
-    interact: interact(MODE),
-  },
   app: {
     background: {
       base: COLORS.COLOR_NEUTRAL_1000,
@@ -238,6 +235,9 @@ const colors = {
 
 const darkTheme = {
   ...lightTheme,
+  utils: {
+    interact: interact(MODE),
+  },
   colors,
   shadows,
   mode: MODE,

package/__flow__/themes/extendedThemes/sproutTheme/dark/theme.js

@@ -1,23 +1,42 @@
 // @flow strict-local
-import clone from "just-clone";
 import baseDarkTheme from "../../../dark/theme";
-import { getDarkThemeColors } from "./getDarkThemeColors";
-import { getNonColorThemeValues } from "../NonColorThemeValues";
-import type { TypeSproutTheme } from "../sproutThemeType.flow";
+import type { TypeSproutTheme } from "../../../../types/theme.flow";
 
-// clone base theme. (we don't want to mutate the base theme)
-const themeClone = clone(baseDarkTheme);
-
-// get non color theme values
-const nonColorThemeValues = getNonColorThemeValues(themeClone);
-
-// get sprout specific dark theme colors
-const darkThemeColors = getDarkThemeColors(themeClone.colors);
+export const navigation = {
+  main: {
+    background: {
+      base: baseDarkTheme.colors.neutral[1000],
+      overflowGradient: baseDarkTheme.colors.neutral[1100],
+    },
+  },
+  secondary: {
+    background: {
+      base: baseDarkTheme.colors.neutral[900],
+    },
+  },
+  text: {
+    base: baseDarkTheme.colors.neutral[0],
+    hover: baseDarkTheme.colors.neutral[0],
+  },
+  icon: {
+    base: baseDarkTheme.colors.neutral[0],
+    hover: baseDarkTheme.colors.neutral[0],
+  },
+  listItem: {
+    background: {
+      base: baseDarkTheme.colors.neutral[1000],
+      hover: baseDarkTheme.colors.neutral[1100],
+      selected: baseDarkTheme.colors.neutral[700],
+    },
+  },
+};
 
 const darkTheme: TypeSproutTheme = {
-  ...themeClone,
-  ...nonColorThemeValues,
-  ...darkThemeColors,
+  ...baseDarkTheme,
+  colors: {
+    ...baseDarkTheme.colors,
+    navigation,
+  },
 };
 
 export default darkTheme;

package/__flow__/themes/extendedThemes/sproutTheme/index.js

@@ -1,4 +1,3 @@
 // @flow
 export { default as sproutLightTheme } from "./light/theme";
 export { default as sproutDarkTheme } from "./dark/theme";
-export type { TypeSproutTheme } from "./sproutThemeType.flow";

package/__flow__/themes/extendedThemes/sproutTheme/light/theme.js

@@ -1,23 +1,42 @@
 // @flow strict-local
-import clone from "just-clone";
 import baseLightTheme from "../../../light/theme";
-import { getLightThemeColors } from "./getLightThemeColors";
-import { getNonColorThemeValues } from "../NonColorThemeValues";
-import type { TypeSproutTheme } from "../sproutThemeType.flow";
+import type { TypeSproutTheme } from "../../../../types/theme.flow";
 
-// clone base theme. (we don't want to mutate the base theme)
-const themeClone = clone(baseLightTheme);
-
-// get non color theme values
-const nonColorThemeValues = getNonColorThemeValues(themeClone);
-
-// get sprout specific light theme colors
-const lightThemeColors = getLightThemeColors(themeClone.colors);
+export const navigation = {
+  main: {
+    background: {
+      base: baseLightTheme.colors.neutral[900],
+      overflowGradient: baseLightTheme.colors.neutral[1000],
+    },
+  },
+  secondary: {
+    background: {
+      base: baseLightTheme.colors.neutral[800],
+    },
+  },
+  text: {
+    base: baseLightTheme.colors.neutral[0],
+    hover: baseLightTheme.colors.neutral[0],
+  },
+  icon: {
+    base: baseLightTheme.colors.neutral[0],
+    hover: baseLightTheme.colors.neutral[0],
+  },
+  listItem: {
+    background: {
+      base: baseLightTheme.colors.neutral[800],
+      hover: baseLightTheme.colors.neutral[1000],
+      selected: baseLightTheme.colors.neutral[700],
+    },
+  },
+};
 
 const lightTheme: TypeSproutTheme = {
-  ...themeClone,
-  ...nonColorThemeValues,
-  ...lightThemeColors,
+  ...baseLightTheme,
+  colors: {
+    ...baseLightTheme.colors,
+    navigation,
+  },
 };
 
 export default lightTheme;