@k-int/stripes-kint-components 2.1.0 → 2.1.3

package/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 2.1.0 In progress
+## 2.1.3 2022-03-10
+* ActionList -- added a hideCreateButton prop for custom rolled solutions
+
+## 2.1.1 2022-03-10
+* Fix -- GenerateQueryParams no longer assumes you want EITHER nsValues filters or options filters, it simply adds both to the params array
+* ActionList -- added a hideCreateButton prop for custom rolled solutions
+## 2.1.0 2022-03-09
 * Fixes for ActionList
   * When no formatter is present, it no longer crashes
   * Formatting for buttons

package/es/lib/ActionList/ActionList.js

@@ -19,7 +19,7 @@ var _ActionListFieldArray = _interopRequireDefault(require("./ActionListFieldArr
 
 var _jsxRuntime = require("react/jsx-runtime");
 
-var _excluded = ["actionAssigner", "actionCalls", "columnMapping", "contentData", "creatableFields", "editableFields", "fieldComponents", "visibleFields"];
+var _excluded = ["actionAssigner", "actionCalls", "columnMapping", "contentData", "creatableFields", "editableFields", "fieldComponents", "hideCreateButton", "visibleFields"];
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -50,6 +50,7 @@ var propTypes = {
   creatableFields: _propTypes.default.object,
   editableFields: _propTypes.default.object,
   fieldComponents: _propTypes.default.object,
+  hideCreateButton: _propTypes.default.bool,
   visibleFields: _propTypes.default.arrayOf(_propTypes.default.string)
 };
 
@@ -65,6 +66,7 @@ var ActionList = function ActionList(_ref) {
       editableFields = _ref$editableFields === void 0 ? {} : _ref$editableFields,
       _ref$fieldComponents = _ref.fieldComponents,
       fieldComponents = _ref$fieldComponents === void 0 ? {} : _ref$fieldComponents,
+      hideCreateButton = _ref.hideCreateButton,
       visibleFields = _ref.visibleFields,
       mclProps = _objectWithoutProperties(_ref, _excluded);
 
@@ -92,6 +94,7 @@ var ActionList = function ActionList(_ref) {
             creatableFields: creatableFields,
             editableFields: editableFields,
             fieldComponents: fieldComponents,
+            hideCreateButton: hideCreateButton,
             name: "contentData",
             visibleFields: visibleFields
           }, mclProps))

package/es/lib/ActionList/ActionListFieldArray.js

@@ -23,7 +23,7 @@ var _ActionListFieldArray = _interopRequireDefault(require("../../../styles/Acti
 
 var _jsxRuntime = require("react/jsx-runtime");
 
-var _excluded = ["actionAssigner", "actionCalls", "columnMapping", "creatableFields", "editableFields", "fields", "fieldComponents", "visibleFields"],
+var _excluded = ["actionAssigner", "actionCalls", "columnMapping", "creatableFields", "editableFields", "fields", "fieldComponents", "hideCreateButton", "visibleFields"],
     _excluded2 = ["actionListActions"],
     _excluded3 = ["actionListActions"],
     _excluded4 = ["actionListActions"],
@@ -88,6 +88,7 @@ var propTypes = {
   fields: _propTypes.default.object,
   fieldComponents: _propTypes.default.object,
   formatter: _propTypes.default.object,
+  hideCreateButton: _propTypes.default.bool,
   visibleFields: _propTypes.default.arrayOf(_propTypes.default.string)
 };
 
@@ -99,6 +100,8 @@ var ActionListFieldArray = function ActionListFieldArray(_ref) {
       editableFields = _ref.editableFields,
       fields = _ref.fields,
       fieldComponents = _ref.fieldComponents,
+      _ref$hideCreateButton = _ref.hideCreateButton,
+      hideCreateButton = _ref$hideCreateButton === void 0 ? false : _ref$hideCreateButton,
       visibleFields = _ref.visibleFields,
       mclProps = _objectWithoutProperties(_ref, _excluded);
 
@@ -328,7 +331,7 @@ var ActionListFieldArray = function ActionListFieldArray(_ref) {
   };
 
   return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
-    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_components.Button, {
+    children: [!hideCreateButton && /*#__PURE__*/(0, _jsxRuntime.jsx)(_components.Button, {
       buttonClass: _ActionListFieldArray.default.buttonRight,
       disabled: !actionCalls.create,
       onClick: function onClick() {

package/es/lib/utils/generateKiwtQueryParams.js

@@ -96,7 +96,9 @@ var generateKiwtQueryParams = function generateKiwtQueryParams(options, nsValues
         }
       }
     });
-  } else if (filters) {
+  }
+
+  if (filters) {
     var filterMap = {};
     filters.split(',').forEach(function (filter) {
       var _filter$trim;
@@ -143,7 +145,9 @@ var generateKiwtQueryParams = function generateKiwtQueryParams(options, nsValues
         paramsArray.push("sort=".concat(os.path, ";").concat((_os$direction = os.direction) !== null && _os$direction !== void 0 ? _os$direction : 'asc'));
       }
     });
-  } else if (sort) {
+  }
+
+  if (sort) {
     var _sort$trim;
 
     paramsArray.push.apply(paramsArray, _toConsumableArray((_sort$trim = sort.trim()) === null || _sort$trim === void 0 ? void 0 : _sort$trim.split(',').map(function (sortKey) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-int/stripes-kint-components",
-  "version": "2.1.0",
+  "version": "2.1.3",
   "description": "Stripes Component library for K-Int specific applications",
   "sideEffects": [
     "*.css"

package/src/lib/ActionList/ActionList.js

@@ -15,6 +15,7 @@ const propTypes = {
   creatableFields: PropTypes.object,
   editableFields: PropTypes.object,
   fieldComponents: PropTypes.object,
+  hideCreateButton: PropTypes.bool,
   visibleFields: PropTypes.arrayOf(PropTypes.string)
 };
 
@@ -26,6 +27,7 @@ const ActionList = ({
   creatableFields = {},
   editableFields = {},
   fieldComponents = {},
+  hideCreateButton,
   visibleFields,
   ...mclProps // Assume anything left over is to directly apply to the MCL
 }) => {
@@ -48,6 +50,7 @@ const ActionList = ({
               creatableFields={creatableFields}
               editableFields={editableFields}
               fieldComponents={fieldComponents}
+              hideCreateButton={hideCreateButton}
               name="contentData"
               visibleFields={visibleFields}
               {...mclProps}

package/src/lib/ActionList/ActionListFieldArray.js

@@ -20,6 +20,7 @@ const propTypes = {
   fields: PropTypes.object,
   fieldComponents: PropTypes.object,
   formatter: PropTypes.object,
+  hideCreateButton: PropTypes.bool,
   visibleFields: PropTypes.arrayOf(PropTypes.string)
 };
 
@@ -31,6 +32,7 @@ const ActionListFieldArray = ({
   editableFields,
   fields,
   fieldComponents,
+  hideCreateButton = false,
   visibleFields,
   ...mclProps // Assume anything left over is to directly apply to the MCL
 }) => {
@@ -242,16 +244,18 @@ const ActionListFieldArray = ({
 
   return (
     <>
-      <Button
-        buttonClass={css.buttonRight}
-        disabled={!actionCalls.create}
-        onClick={() => {
-          toggleEditing('NEW_ROW');
-          fields.push({});
-        }}
-      >
-        <FormattedMessage id="stripes-kint-components.actionList.create" />
-      </Button>
+      {!hideCreateButton && 
+        <Button
+          buttonClass={css.buttonRight}
+          disabled={!actionCalls.create}
+          onClick={() => {
+            toggleEditing('NEW_ROW');
+            fields.push({});
+          }}
+        >
+          <FormattedMessage id="stripes-kint-components.actionList.create" />
+        </Button>
+      }
       <MultiColumnList
         columnMapping={{
           ...columnMapping,

package/src/lib/ActionList/README.md

@@ -65,5 +65,6 @@ creatableFields | object<function> | An object with keys from the `visibleFields
 editableFields | object<function> | An object with keys from the `visibleFields` array, and values of functions which take the entire row object and return a boolean indicating whether that field is editable or not. No key for a given field will be interpreted as () => true, so a field is editable by default. | | ✕ |
 fieldComponents | object<function> | An object with keys from the `visibleFields` array, and values of functions which take some `fieldProps` (currently only the name of the field `name`), and returns a Field component to be used in "edit mode" for the visible field specified. | | ✕ |
 formatter | object<function> | A "formatter" object that takes the same shape as an MCL formatter, and is used in the same way whilst a row is NOT being edited. While editing a given row, this formatter entry is ignored. | | ✕ |
+hideCreateButton | boolean | A simple bool to hide the create button. Default behaviour without create action is disabled. | false | ✕ |
 visibleFields | array<String> | An array of strings corresponding to those fields to be displayed in the rendered MultiColumnList | | ✓ |
 ...mclProps | any | Any other props supplied to ActionList will be applied to the MCL directly. *WARNING* Some MCL props may override important functionality within ActionList | | ✕ |

package/src/lib/utils/generateKiwtQueryParams.js

@@ -6,14 +6,12 @@ const generateKiwtQueryParams = (options, nsValues) => {
     filterKeys = {},
     sortKeys = {},
     stats = true,
-    /* Assumption made that if a direct sort array is passed in options, it overrides the nsValues
-     * Of the form [{ path: 'this.is.some.path', direction: 'asc'/'desc', value: 'someOverrideValue'}, ...]
+    /* Of the form [{ path: 'this.is.some.path', direction: 'asc'/'desc', value: 'someOverrideValue'}, ...]
      * If only path is passed then assume asc.
      * If value is passed then we ignore path/direction and append "sort=${value}" directly
      */
     sort: optionsSort,
-     /* Assumption made that if a direct filters array is passed in options, it overrides the nsValues
-     * Of the form
+    /* Of the form
       [
         {
           path: 'this.is.some.path'
@@ -62,7 +60,9 @@ const generateKiwtQueryParams = (options, nsValues) => {
         }
       }
     });
-  } else if (filters) {
+  }
+  
+  if (filters) {
     const filterMap = {};
     filters.split(',').forEach(filter => {
       const [filterName, ...filterRest] = filter.trim()?.split('.');
@@ -94,7 +94,9 @@ const generateKiwtQueryParams = (options, nsValues) => {
         paramsArray.push(`sort=${os.path};${os.direction ?? 'asc'}`);
       }
     });
-  } else if (sort) {
+  }
+  
+  if (sort) {
     paramsArray.push(...sort.trim()?.split(',').map(sortKey => {
       const descending = sortKey.startsWith('-');
       let term = sortKey.replace('-', '');