@storybook/components 6.4.0-beta.24 → 6.4.0-beta.28

package/dist/esm/blocks/ArgsTable/ArgRow.stories.js

@@ -0,0 +1,358 @@
+import "core-js/modules/es.object.assign.js";
+import React from 'react';
+import { action } from '@storybook/addon-actions';
+import { ArgRow } from './ArgRow';
+import { TableWrapper } from './ArgsTable';
+import { ResetWrapper } from '../../typography/DocumentFormatting';
+export default {
+  component: ArgRow,
+  title: 'Docs/ArgRow',
+  decorators: [function (getStory) {
+    return /*#__PURE__*/React.createElement(ResetWrapper, null, /*#__PURE__*/React.createElement(TableWrapper, null, /*#__PURE__*/React.createElement("tbody", null, getStory())));
+  }]
+};
+
+var Template = function Template(args) {
+  return /*#__PURE__*/React.createElement(ArgRow, args);
+};
+
+Template.displayName = "Template";
+var baseArgs = {
+  updateArgs: action('updateArgs')
+};
+export var String = Template.bind({});
+String.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someString',
+    name: 'Some String',
+    description: 'someString description',
+    type: {
+      required: true
+    },
+    control: {
+      type: 'text'
+    },
+    table: {
+      type: {
+        summary: 'string'
+      },
+      defaultValue: {
+        summary: 'reallylongstringnospaces'
+      }
+    }
+  }
+});
+export var LongName = Template.bind({});
+LongName.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, String.args.row, {
+    name: 'Really Long String That Takes Up Space'
+  })
+});
+export var LongDesc = Template.bind({});
+LongDesc.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, String.args.row, {
+    description: 'really long description that takes up a lot of space. sometimes this happens.'
+  })
+});
+export var Boolean = Template.bind({});
+Boolean.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someBoolean',
+    name: 'Some Boolean',
+    description: 'someBoolean description',
+    type: {
+      required: true
+    },
+    control: {
+      type: 'boolean'
+    },
+    table: {
+      type: {
+        summary: 'string'
+      },
+      defaultValue: {
+        summary: 'fixme'
+      }
+    }
+  }
+});
+export var Color = Template.bind({});
+Color.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someColor',
+    name: 'Some Color',
+    type: {
+      name: 'string'
+    },
+    description: 'someColor description',
+    defaultValue: '#ff0',
+    control: {
+      type: 'color'
+    }
+  }
+});
+export var Date = Template.bind({});
+Date.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someDate',
+    name: 'Some Date',
+    type: {
+      name: 'string'
+    },
+    description: 'someDate description',
+    control: {
+      type: 'date'
+    }
+  }
+});
+export var Number = Template.bind({});
+Number.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someNumber',
+    name: 'Some Number',
+    description: 'someNumber description',
+    type: {
+      required: false
+    },
+    table: {
+      type: {
+        summary: 'number'
+      },
+      defaultValue: {
+        summary: '0'
+      }
+    },
+    control: {
+      type: 'number'
+    }
+  }
+});
+export var Range = Template.bind({});
+Range.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Number.args.row, {
+    control: {
+      type: 'range'
+    }
+  })
+});
+export var Radio = Template.bind({});
+Radio.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someEnum',
+    name: 'Some Enum',
+    description: 'someEnum description',
+    control: {
+      type: 'radio',
+      options: ['a', 'b', 'c']
+    }
+  }
+});
+export var InlineRadio = Template.bind({});
+InlineRadio.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Radio.args.row, {
+    control: Object.assign({}, Radio.args.row.control, {
+      type: 'inline-radio'
+    })
+  })
+});
+export var Check = Template.bind({});
+Check.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Radio.args.row, {
+    control: Object.assign({}, Radio.args.row.control, {
+      type: 'check'
+    })
+  })
+});
+export var InlineCheck = Template.bind({});
+InlineCheck.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Radio.args.row, {
+    control: Object.assign({}, Radio.args.row.control, {
+      type: 'inline-check'
+    })
+  })
+});
+export var Select = Template.bind({});
+Select.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Radio.args.row, {
+    control: Object.assign({}, Radio.args.row.control, {
+      type: 'select'
+    })
+  })
+});
+export var MultiSelect = Template.bind({});
+MultiSelect.args = Object.assign({}, baseArgs, {
+  row: Object.assign({}, Radio.args.row, {
+    control: Object.assign({}, Radio.args.row.control, {
+      type: 'multi-select'
+    })
+  })
+});
+export var ObjectOf = Template.bind({});
+ObjectOf.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someObject',
+    name: 'Some Object',
+    description: 'A simple `objectOf` propType.',
+    table: {
+      type: {
+        summary: 'objectOf(number)'
+      },
+      defaultValue: {
+        summary: '{ key: 1 }'
+      }
+    },
+    control: {
+      type: 'object'
+    }
+  }
+});
+export var ArrayOf = Template.bind({});
+ArrayOf.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someArray',
+    name: 'Some Array',
+    description: 'array of a certain type',
+    table: {
+      type: {
+        summary: 'number[]'
+      },
+      defaultValue: {
+        summary: '[1, 2, 3]'
+      }
+    },
+    control: {
+      type: 'array'
+    }
+  }
+});
+export var ComplexObject = Template.bind({});
+ComplexObject.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someComplex',
+    name: 'Some Complex',
+    description: 'A very complex `objectOf` propType.',
+    table: {
+      type: {
+        summary: 'object',
+        detail: "[{\n      id: number,\n      func: func,\n      arr: [{ index: number }]\n    }]"
+      },
+      defaultValue: {
+        summary: 'object',
+        detail: "[{\n      id: 1,\n      func: () => {},\n      arr: [{ index: 1 }]\n    }]"
+      }
+    },
+    control: {
+      type: 'object'
+    }
+  }
+});
+export var Func = Template.bind({});
+Func.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'concat',
+    name: 'Concat',
+    description: 'concat 2 string values.',
+    type: {
+      required: true
+    },
+    table: {
+      type: {
+        summary: '(a: string, b: string) => string'
+      },
+      defaultValue: {
+        summary: 'func',
+        detail: '(a, b) => { return a + b; }'
+      },
+      jsDocTags: {
+        params: [{
+          name: 'a',
+          description: 'The first string'
+        }, {
+          name: 'b',
+          description: 'The second string'
+        }],
+        returns: {
+          description: 'The concatenation of both strings'
+        }
+      }
+    },
+    control: false
+  }
+});
+var enumeration = '"search" | "arrow-to-bottom" | "arrow-to-right" | "bell" | "check" | "check-circle"';
+export var Enum = Template.bind({});
+Enum.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'enum',
+    name: 'Some enum',
+    type: {
+      required: true
+    },
+    table: {
+      type: {
+        summary: enumeration
+      }
+    }
+  }
+});
+var long_enumeration = '"search" | "arrow-to-bottom" | "arrow-to-right" | "bell" | "check" | "check-circle" | "chevron-up" | "chevron-down" | "chevron-left" | "chevron-right" | "envelope" | "exchange" | "file" | "file-check" | "file-import" | "file-pdf" | "file-times" | "pencil" | "question" | "question-circle" | "sitemap" | "user" | "times" | "plus" | "exclamation-triangle" | "trash-alt" | "long-arrow-up" | "long-arrow-down" | "long-arrow-left" | "long-arrow-right" | "external-link-alt" | "sticky-note" | "chart-line" | "spinner-third"';
+export var LongEnum = Template.bind({});
+LongEnum.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'longEnum',
+    name: 'Long enum',
+    type: {
+      required: true
+    },
+    table: {
+      type: {
+        summary: long_enumeration
+      }
+    }
+  }
+});
+var complexUnion = '((a: string | SVGSVGElement) => void) | RefObject<SVGSVGElement | number> | [a|b] | {a|b}';
+export var ComplexUnion = Template.bind({});
+ComplexUnion.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'complexUnion',
+    name: 'Complex',
+    type: {
+      required: true
+    },
+    table: {
+      type: {
+        summary: complexUnion
+      }
+    }
+  }
+});
+export var Markdown = Template.bind({});
+Markdown.args = Object.assign({}, baseArgs, {
+  row: {
+    key: 'someString',
+    name: 'Some String',
+    description: 'A `prop` can *support* __markdown__ syntax. This was ship in ~~5.2~~ 5.3. [Find more info in the storybook docs.](https://storybook.js.org/)',
+    table: {
+      type: {
+        summary: 'string'
+      }
+    },
+    control: {
+      type: 'text'
+    }
+  }
+});
+export var StringCompact = Template.bind({});
+StringCompact.args = Object.assign({}, String.args, {
+  compact: true
+});
+export var StringNoControls = Template.bind({});
+StringNoControls.args = {
+  row: String.args.row
+};
+export var StringNoControlsCompact = Template.bind({});
+StringNoControlsCompact.args = {
+  row: String.args.row,
+  compact: true
+};

package/dist/esm/blocks/ArgsTable/ArgValue.js

@@ -0,0 +1,246 @@
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+import "core-js/modules/es.object.assign.js";
+import "core-js/modules/es.string.split.js";
+import "core-js/modules/es.regexp.exec.js";
+import "core-js/modules/es.array.map.js";
+import "core-js/modules/es.string.trim.js";
+import "core-js/modules/es.array.slice.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/es.regexp.to-string.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.symbol.description.js";
+import "core-js/modules/es.symbol.iterator.js";
+import "core-js/modules/es.string.iterator.js";
+import "core-js/modules/es.array.iterator.js";
+import "core-js/modules/web.dom-collections.iterator.js";
+import "core-js/modules/es.array.from.js";
+import "core-js/modules/es.function.name.js";
+import React, { useState } from 'react';
+import { styled } from '@storybook/theming';
+import memoize from 'memoizerific';
+import uniq from 'lodash/uniq';
+import { WithTooltipPure } from '../../tooltip/lazy-WithTooltip';
+import { Icons } from '../../icon/icon';
+import { SyntaxHighlighter } from '../../syntaxhighlighter/lazy-syntaxhighlighter';
+import { codeCommon } from '../../typography/shared';
+var ITEMS_BEFORE_EXPANSION = 8;
+var Summary = styled.div(function (_ref) {
+  var isExpanded = _ref.isExpanded;
+  return {
+    display: 'flex',
+    flexDirection: isExpanded ? 'column' : 'row',
+    flexWrap: 'wrap',
+    alignItems: 'flex-start',
+    marginBottom: '-4px',
+    minWidth: 100
+  };
+});
+var Text = styled.span(codeCommon, function (_ref2) {
+  var theme = _ref2.theme,
+      _ref2$simple = _ref2.simple,
+      simple = _ref2$simple === void 0 ? false : _ref2$simple;
+  return Object.assign({
+    flex: '0 0 auto',
+    fontFamily: theme.typography.fonts.mono,
+    fontSize: theme.typography.size.s1,
+    wordBreak: 'break-word',
+    whiteSpace: 'normal',
+    maxWidth: '100%',
+    margin: 0,
+    marginRight: '4px',
+    marginBottom: '4px',
+    paddingTop: '2px',
+    paddingBottom: '2px',
+    lineHeight: '13px'
+  }, simple && {
+    background: 'transparent',
+    border: '0 none',
+    paddingLeft: 0
+  });
+});
+var ExpandButton = styled.button(function (_ref3) {
+  var theme = _ref3.theme;
+  return {
+    fontFamily: theme.typography.fonts.mono,
+    color: theme.color.secondary,
+    marginBottom: '4px',
+    background: 'none',
+    border: 'none'
+  };
+});
+var Expandable = styled.div(codeCommon, function (_ref4) {
+  var theme = _ref4.theme;
+  return {
+    fontFamily: theme.typography.fonts.mono,
+    color: theme.color.secondary,
+    fontSize: theme.typography.size.s1,
+    // overrides codeCommon
+    margin: 0,
+    whiteSpace: 'nowrap',
+    display: 'flex',
+    alignItems: 'center'
+  };
+});
+var Detail = styled.div(function (_ref5) {
+  var theme = _ref5.theme,
+      width = _ref5.width;
+  return {
+    width: width,
+    minWidth: 200,
+    maxWidth: 800,
+    padding: 15,
+    // Dont remove the mono fontFamily here even if it seem useless, this is used by the browser to calculate the length of a "ch" unit.
+    fontFamily: theme.typography.fonts.mono,
+    fontSize: theme.typography.size.s1,
+    // Most custom stylesheet will reset the box-sizing to "border-box" and will break the tooltip.
+    boxSizing: 'content-box',
+    '& code': {
+      padding: '0 !important'
+    }
+  };
+});
+var ArrowIcon = styled(Icons)({
+  height: 10,
+  width: 10,
+  minWidth: 10,
+  marginLeft: 4
+});
+
+var EmptyArg = function EmptyArg() {
+  return /*#__PURE__*/React.createElement("span", null, "-");
+};
+
+EmptyArg.displayName = "EmptyArg";
+
+var ArgText = function ArgText(_ref6) {
+  var text = _ref6.text,
+      simple = _ref6.simple;
+  return /*#__PURE__*/React.createElement(Text, {
+    simple: simple
+  }, text);
+};
+
+ArgText.displayName = "ArgText";
+var calculateDetailWidth = memoize(1000)(function (detail) {
+  var lines = detail.split(/\r?\n/);
+  return "".concat(Math.max.apply(Math, _toConsumableArray(lines.map(function (x) {
+    return x.length;
+  }))), "ch");
+});
+
+var getSummaryItems = function getSummaryItems(summary) {
+  if (!summary) return [summary];
+  var splittedItems = summary.split('|');
+  var summaryItems = splittedItems.map(function (value) {
+    return value.trim();
+  });
+  return uniq(summaryItems);
+};
+
+var renderSummaryItems = function renderSummaryItems(summaryItems) {
+  var isExpanded = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  var items = summaryItems;
+
+  if (!isExpanded) {
+    items = summaryItems.slice(0, ITEMS_BEFORE_EXPANSION);
+  }
+
+  return items.map(function (item) {
+    return /*#__PURE__*/React.createElement(ArgText, {
+      key: item,
+      text: item === '' ? '""' : item
+    });
+  });
+};
+
+var ArgSummary = function ArgSummary(_ref7) {
+  var value = _ref7.value,
+      initialExpandedArgs = _ref7.initialExpandedArgs;
+  var summary = value.summary,
+      detail = value.detail;
+
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      isOpen = _useState2[0],
+      setIsOpen = _useState2[1];
+
+  var _useState3 = useState(initialExpandedArgs || false),
+      _useState4 = _slicedToArray(_useState3, 2),
+      isExpanded = _useState4[0],
+      setIsExpanded = _useState4[1];
+
+  if (summary === undefined || summary === null) return null; // summary is used for the default value
+  // below check fixes not displaying default values for boolean typescript vars
+
+  var summaryAsString = typeof summary.toString === 'function' ? summary.toString() : summary;
+
+  if (detail == null) {
+    var cannotBeSafelySplitted = /[(){}[\]<>]/.test(summaryAsString);
+
+    if (cannotBeSafelySplitted) {
+      return /*#__PURE__*/React.createElement(ArgText, {
+        text: summaryAsString
+      });
+    }
+
+    var summaryItems = getSummaryItems(summaryAsString);
+    var itemsCount = summaryItems.length;
+    var hasManyItems = itemsCount > ITEMS_BEFORE_EXPANSION;
+    return hasManyItems ? /*#__PURE__*/React.createElement(Summary, {
+      isExpanded: isExpanded
+    }, renderSummaryItems(summaryItems, isExpanded), /*#__PURE__*/React.createElement(ExpandButton, {
+      onClick: function onClick() {
+        return setIsExpanded(!isExpanded);
+      }
+    }, isExpanded ? 'Show less...' : "Show ".concat(itemsCount - ITEMS_BEFORE_EXPANSION, " more..."))) : /*#__PURE__*/React.createElement(Summary, null, renderSummaryItems(summaryItems));
+  }
+
+  return /*#__PURE__*/React.createElement(WithTooltipPure, {
+    closeOnClick: true,
+    trigger: "click",
+    placement: "bottom",
+    tooltipShown: isOpen,
+    onVisibilityChange: function onVisibilityChange(isVisible) {
+      setIsOpen(isVisible);
+    },
+    tooltip: /*#__PURE__*/React.createElement(Detail, {
+      width: calculateDetailWidth(detail)
+    }, /*#__PURE__*/React.createElement(SyntaxHighlighter, {
+      language: "jsx",
+      format: false
+    }, detail))
+  }, /*#__PURE__*/React.createElement(Expandable, {
+    className: "sbdocs-expandable"
+  }, /*#__PURE__*/React.createElement("span", null, summaryAsString), /*#__PURE__*/React.createElement(ArrowIcon, {
+    icon: isOpen ? 'arrowup' : 'arrowdown'
+  })));
+};
+
+ArgSummary.displayName = "ArgSummary";
+export var ArgValue = function ArgValue(_ref8) {
+  var value = _ref8.value,
+      initialExpandedArgs = _ref8.initialExpandedArgs;
+  return value == null ? /*#__PURE__*/React.createElement(EmptyArg, null) : /*#__PURE__*/React.createElement(ArgSummary, {
+    value: value,
+    initialExpandedArgs: initialExpandedArgs
+  });
+};