@dhis2-ui/alert 9.5.0-alpha.1 → 9.5.0

package/build/cjs/alert-bar/alert-bar.js

@@ -165,7 +165,8 @@ AlertBar.defaultProps = {
   icon: true
 };
 AlertBar.propTypes = {
-  /** An array of 0-2 action objects */
+  /** An array of 0-2 action objects 
+  `[{label: "Save", onClick: clickHandler}]`*/
   actions: _actions.actionsPropType,
 
   /** The message string for the alert */
@@ -175,7 +176,11 @@ AlertBar.propTypes = {
   /** Alert bars with `critical` will not autohide */
   critical: alertTypePropType,
   dataTest: _propTypes2.default.string,
+
+  /** How long you want the notification to display, in `ms`, when it's not permanent */
   duration: _propTypes2.default.number,
+
+  /** AlertBar will be hidden on creation when this is set to true */
   hidden: _propTypes2.default.bool,
 
   /**
@@ -183,6 +188,8 @@ AlertBar.propTypes = {
    * If `false` is provided, no icon will be shown.
    */
   icon: _icon.iconPropType,
+
+  /** When set, AlertBar will not autohide */
   permanent: _propTypes2.default.bool,
   success: alertTypePropType,
 

package/build/cjs/alert-bar/features/api/index.js

@@ -1,37 +1,39 @@
 "use strict";
 
-require("../common/index.js");
+var _cypressCucumberPreprocessor = require("@badeball/cypress-cucumber-preprocessor");
 
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with onHidden handler is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with onHidden handler is rendered', () => {
   cy.visitStory('AlertBar', 'With onHidden');
 });
-(0, _steps.Given)('an AlertBar with disabled icon is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with disabled icon is rendered', () => {
   cy.visitStory('AlertBar', 'Disabled icon');
 });
-(0, _steps.Given)('an AlertBar with custom icon is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with custom icon is rendered', () => {
   cy.visitStory('AlertBar', 'Custom icon');
 });
-(0, _steps.Given)('an AlertBar with a message is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with a message is rendered', () => {
   cy.visitStory('AlertBar', 'With message');
 });
-(0, _steps.Given)('an AlertBar with permanent is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with permanent is rendered', () => {
   cy.visitStory('AlertBar', 'Permanent');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-(0, _steps.Then)('the icon will be visible', () => {
+(0, _cypressCucumberPreprocessor.When)('the Alertbar is not rendered', () => {
+  cy.wait(8000);
+  cy.get('[data-test="dhis2-uicore-alertbar"]').should('not.exist');
+});
+(0, _cypressCucumberPreprocessor.Then)('the icon will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('be.visible');
 });
-(0, _steps.Then)('the icon will not be rendered', () => {
+(0, _cypressCucumberPreprocessor.Then)('the icon will not be rendered', () => {
   cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('not.exist');
 });
-(0, _steps.Then)('the custom icon will be visible', () => {
+(0, _cypressCucumberPreprocessor.Then)('the custom icon will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar-icon"]').contains('Custom icon').should('be.visible');
 });
-(0, _steps.Then)('the message will be visible', () => {
+(0, _cypressCucumberPreprocessor.Then)('the message will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar"]').contains('With a message').should('be.visible');
 });
-(0, _steps.Then)('the AlertBar will be visible', () => {
+(0, _cypressCucumberPreprocessor.Then)('the AlertBar will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });

package/build/cjs/alert-bar/features/common/index.js

@@ -1,22 +1,22 @@
 "use strict";
 
-var _steps = require("cypress-cucumber-preprocessor/steps");
+var _cypressCucumberPreprocessor = require("@badeball/cypress-cucumber-preprocessor");
 
-(0, _steps.Given)('a default AlertBar is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('a default AlertBar is rendered', () => {
   cy.visitStory('AlertBar', 'Default');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-(0, _steps.Given)('the AlertBar is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('the AlertBar is rendered', () => {
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('exist');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-(0, _steps.Then)('the AlertBar is not rendered', () => {
+(0, _cypressCucumberPreprocessor.Then)('the AlertBar is not rendered', () => {
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('not.exist');
 });
-(0, _steps.When)('the default duration has passed', () => {
+(0, _cypressCucumberPreprocessor.When)('the default duration has passed', () => {
   cy.wait(8000);
 });
-(0, _steps.Then)('the onHidden handler is called', () => {
+(0, _cypressCucumberPreprocessor.Then)('the onHidden handler is called', () => {
   cy.window().should(win => {
     expect(win.onHidden).to.be.calledOnce;
     expect(win.onHidden).to.be.calledWith({}, null);

package/build/cjs/alert-bar/features/hide/index.js

@@ -1,34 +1,29 @@
 "use strict";
 
-require("../common/index.js");
+var _cypressCucumberPreprocessor = require("@badeball/cypress-cucumber-preprocessor");
 
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with a custom duration is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('a permanent AlertBar with hidden and onHidden is rendered', () => {
+  cy.visitStory('AlertBar', 'Hidden prop');
+});
+(0, _cypressCucumberPreprocessor.Given)('an AlertBar with a custom duration is rendered', () => {
   cy.visitStory('AlertBar', 'Custom duration');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-(0, _steps.Given)('a permanent AlertBar with actions is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('a permanent AlertBar with actions is rendered', () => {
   cy.visitStory('AlertBar', 'Permanent with actions');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-(0, _steps.Given)('a permanent AlertBar with hidden and onHidden is rendered', () => {
-  cy.visitStory('AlertBar', 'Hidden prop');
-});
-(0, _steps.When)('the custom duration has passed', () => {
-  cy.wait(2000);
+(0, _cypressCucumberPreprocessor.When)('the user clicks on the "Cancel" button', () => {
+  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
 });
-(0, _steps.When)('the default duration has passed', () => {
-  cy.wait(8000);
+(0, _cypressCucumberPreprocessor.When)('the user click a button which toggles the hidden prop', () => {
+  cy.get('button').click();
 });
-(0, _steps.When)('the user clicks on the "Cancel" button', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
+(0, _cypressCucumberPreprocessor.When)('the custom duration has passed', () => {
+  cy.wait(2000);
 });
-(0, _steps.Then)('the onHidden handler is not called', () => {
+(0, _cypressCucumberPreprocessor.Then)('the onHidden handler is not called', () => {
   cy.window().should(win => {
     expect(win.onHidden).to.not.be.called;
   });
-});
-(0, _steps.When)('the user click a button which toggles the hidden prop', () => {
-  cy.get('button').click();
 });

package/build/cjs/alert-stack/features/render_children/alertbars.js

@@ -1,12 +1,12 @@
 "use strict";
 
-var _steps = require("cypress-cucumber-preprocessor/steps");
+var _cypressCucumberPreprocessor = require("@badeball/cypress-cucumber-preprocessor");
 
-(0, _steps.Given)('an AlertStack with multiple AlertBars is rendered', () => {
+(0, _cypressCucumberPreprocessor.Given)('an AlertStack with multiple AlertBars is rendered', () => {
   cy.visitStory('Alertstack', 'Default');
   cy.get('[data-test="dhis2-uicore-alertstack"]').should('be.visible');
 });
-(0, _steps.Then)('the AlertBars will be visible', () => {
+(0, _cypressCucumberPreprocessor.Then)('the AlertBars will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('have.length', 3);
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });

package/build/es/alert-bar/alert-bar.js

@@ -142,7 +142,8 @@ AlertBar.defaultProps = {
   icon: true
 };
 AlertBar.propTypes = {
-  /** An array of 0-2 action objects */
+  /** An array of 0-2 action objects 
+  `[{label: "Save", onClick: clickHandler}]`*/
   actions: actionsPropType,
 
   /** The message string for the alert */
@@ -152,7 +153,11 @@ AlertBar.propTypes = {
   /** Alert bars with `critical` will not autohide */
   critical: alertTypePropType,
   dataTest: PropTypes.string,
+
+  /** How long you want the notification to display, in `ms`, when it's not permanent */
   duration: PropTypes.number,
+
+  /** AlertBar will be hidden on creation when this is set to true */
   hidden: PropTypes.bool,
 
   /**
@@ -160,6 +165,8 @@ AlertBar.propTypes = {
    * If `false` is provided, no icon will be shown.
    */
   icon: iconPropType,
+
+  /** When set, AlertBar will not autohide */
   permanent: PropTypes.bool,
   success: alertTypePropType,
 

package/build/es/alert-bar/features/api/index.js

@@ -1,5 +1,4 @@
-import '../common/index.js';
-import { Given, Then } from 'cypress-cucumber-preprocessor/steps';
+import { Given, When, Then } from '@badeball/cypress-cucumber-preprocessor';
 Given('an AlertBar with onHidden handler is rendered', () => {
   cy.visitStory('AlertBar', 'With onHidden');
 });
@@ -16,6 +15,10 @@ Given('an AlertBar with permanent is rendered', () => {
   cy.visitStory('AlertBar', 'Permanent');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
+When('the Alertbar is not rendered', () => {
+  cy.wait(8000);
+  cy.get('[data-test="dhis2-uicore-alertbar"]').should('not.exist');
+});
 Then('the icon will be visible', () => {
   cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('be.visible');
 });

package/build/es/alert-bar/features/common/index.js

@@ -1,4 +1,4 @@
-import { When, Given, Then } from 'cypress-cucumber-preprocessor/steps';
+import { When, Given, Then } from '@badeball/cypress-cucumber-preprocessor';
 Given('a default AlertBar is rendered', () => {
   cy.visitStory('AlertBar', 'Default');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');

package/build/es/alert-bar/features/hide/index.js

@@ -1,5 +1,7 @@
-import '../common/index.js';
-import { Given, When, Then } from 'cypress-cucumber-preprocessor/steps';
+import { Given, When, Then } from '@badeball/cypress-cucumber-preprocessor';
+Given('a permanent AlertBar with hidden and onHidden is rendered', () => {
+  cy.visitStory('AlertBar', 'Hidden prop');
+});
 Given('an AlertBar with a custom duration is rendered', () => {
   cy.visitStory('AlertBar', 'Custom duration');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
@@ -8,23 +10,17 @@ Given('a permanent AlertBar with actions is rendered', () => {
   cy.visitStory('AlertBar', 'Permanent with actions');
   cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
 });
-Given('a permanent AlertBar with hidden and onHidden is rendered', () => {
-  cy.visitStory('AlertBar', 'Hidden prop');
+When('the user clicks on the "Cancel" button', () => {
+  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
+});
+When('the user click a button which toggles the hidden prop', () => {
+  cy.get('button').click();
 });
 When('the custom duration has passed', () => {
   cy.wait(2000);
 });
-When('the default duration has passed', () => {
-  cy.wait(8000);
-});
-When('the user clicks on the "Cancel" button', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
-});
 Then('the onHidden handler is not called', () => {
   cy.window().should(win => {
     expect(win.onHidden).to.not.be.called;
   });
-});
-When('the user click a button which toggles the hidden prop', () => {
-  cy.get('button').click();
 });

package/build/es/alert-stack/features/render_children/alertbars.js

@@ -1,4 +1,4 @@
-import { Given, Then } from 'cypress-cucumber-preprocessor/steps';
+import { Given, Then } from '@badeball/cypress-cucumber-preprocessor';
 Given('an AlertStack with multiple AlertBars is rendered', () => {
   cy.visitStory('Alertstack', 'Default');
   cy.get('[data-test="dhis2-uicore-alertstack"]').should('be.visible');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2-ui/alert",
-    "version": "9.5.0-alpha.1",
+    "version": "9.5.0",
     "description": "UI Alert",
     "repository": {
         "type": "git",
@@ -33,9 +33,9 @@
     },
     "dependencies": {
         "@dhis2/prop-types": "^3.1.2",
-        "@dhis2-ui/portal": "9.5.0-alpha.1",
-        "@dhis2/ui-constants": "9.5.0-alpha.1",
-        "@dhis2/ui-icons": "9.5.0-alpha.1",
+        "@dhis2-ui/portal": "9.5.0",
+        "@dhis2/ui-constants": "9.5.0",
+        "@dhis2/ui-icons": "9.5.0",
         "classnames": "^2.3.1",
         "prop-types": "^15.7.2"
     },

package/build/cjs/alert-bar/features/api/hidden_callback.js

@@ -1,19 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an Alertbar with onHidden handler is rendered', () => {
-  cy.visitStory('Alertbar', 'With onHidden');
-});
-(0, _steps.When)('the Alertbar is not rendered', () => {
-  cy.wait(8000);
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('not.exist');
-});
-(0, _steps.Then)('the onHidden handler is called', () => {
-  cy.window().should(win => {
-    expect(win.onHidden).to.be.calledOnce;
-    expect(win.onHidden).to.be.calledWith({}, null);
-  });
-});

package/build/cjs/alert-bar/features/api/prop_message.js

@@ -1,37 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with onHidden handler is rendered', () => {
-  cy.visitStory('AlertBar', 'With onHidden');
-});
-(0, _steps.Given)('an AlertBar with disabled icon is rendered', () => {
-  cy.visitStory('AlertBar', 'Disabled icon');
-});
-(0, _steps.Given)('an AlertBar with custom icon is rendered', () => {
-  cy.visitStory('AlertBar', 'Custom icon');
-});
-(0, _steps.Given)('an AlertBar with a message is rendered', () => {
-  cy.visitStory('AlertBar', 'With message');
-});
-(0, _steps.Given)('an AlertBar with permanent is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-(0, _steps.Then)('the icon will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('be.visible');
-});
-(0, _steps.Then)('the icon will not be rendered', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('not.exist');
-});
-(0, _steps.Then)('the custom icon will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').contains('Custom icon').should('be.visible');
-});
-(0, _steps.Then)('the message will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').contains('With a message').should('be.visible');
-});
-(0, _steps.Then)('the AlertBar will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});

package/build/cjs/alert-bar/features/api/props_message.js

@@ -1,12 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with a message is rendered', () => {
-  cy.visitStory('AlertBar', 'With message');
-});
-(0, _steps.Then)('the message will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').contains('With a message').should('be.visible');
-});

package/build/cjs/alert-bar/features/api/props_permanent.js

@@ -1,13 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with permanent is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-(0, _steps.Then)('the AlertBar will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});

package/build/cjs/alert-bar/features/hide/automatically.js

@@ -1,16 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('an AlertBar with a custom duration is rendered', () => {
-  cy.visitStory('AlertBar', 'Custom duration');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-(0, _steps.When)('the custom duration has passed', () => {
-  cy.wait(2000);
-});
-(0, _steps.When)('the default duration has passed', () => {
-  cy.wait(8000);
-});

package/build/cjs/alert-bar/features/hide/on_action.js

@@ -1,13 +0,0 @@
-"use strict";
-
-require("../common/index.js");
-
-var _steps = require("cypress-cucumber-preprocessor/steps");
-
-(0, _steps.Given)('a permanent AlertBar with actions is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent with actions');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-(0, _steps.When)('the user clicks on the "Cancel" button', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
-});

package/build/es/alert-bar/features/api/hidden_callback.js

@@ -1,15 +0,0 @@
-import '../common/index.js';
-import { Given, When, Then } from 'cypress-cucumber-preprocessor/steps';
-Given('an Alertbar with onHidden handler is rendered', () => {
-  cy.visitStory('Alertbar', 'With onHidden');
-});
-When('the Alertbar is not rendered', () => {
-  cy.wait(8000);
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('not.exist');
-});
-Then('the onHidden handler is called', () => {
-  cy.window().should(win => {
-    expect(win.onHidden).to.be.calledOnce;
-    expect(win.onHidden).to.be.calledWith({}, null);
-  });
-});

package/build/es/alert-bar/features/api/prop_message.js

@@ -1,33 +0,0 @@
-import '../common/index.js';
-import { Given, Then } from 'cypress-cucumber-preprocessor/steps';
-Given('an AlertBar with onHidden handler is rendered', () => {
-  cy.visitStory('AlertBar', 'With onHidden');
-});
-Given('an AlertBar with disabled icon is rendered', () => {
-  cy.visitStory('AlertBar', 'Disabled icon');
-});
-Given('an AlertBar with custom icon is rendered', () => {
-  cy.visitStory('AlertBar', 'Custom icon');
-});
-Given('an AlertBar with a message is rendered', () => {
-  cy.visitStory('AlertBar', 'With message');
-});
-Given('an AlertBar with permanent is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-Then('the icon will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('be.visible');
-});
-Then('the icon will not be rendered', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').should('not.exist');
-});
-Then('the custom icon will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-icon"]').contains('Custom icon').should('be.visible');
-});
-Then('the message will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').contains('With a message').should('be.visible');
-});
-Then('the AlertBar will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});

package/build/es/alert-bar/features/api/props_message.js

@@ -1,8 +0,0 @@
-import '../common/index.js';
-import { Given, Then } from 'cypress-cucumber-preprocessor/steps';
-Given('an AlertBar with a message is rendered', () => {
-  cy.visitStory('AlertBar', 'With message');
-});
-Then('the message will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').contains('With a message').should('be.visible');
-});

package/build/es/alert-bar/features/api/props_permanent.js

@@ -1,9 +0,0 @@
-import '../common/index.js';
-import { Given, Then } from 'cypress-cucumber-preprocessor/steps';
-Given('an AlertBar with permanent is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-Then('the AlertBar will be visible', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});

package/build/es/alert-bar/features/hide/automatically.js

@@ -1,12 +0,0 @@
-import '../common/index.js';
-import { Given, When } from 'cypress-cucumber-preprocessor/steps';
-Given('an AlertBar with a custom duration is rendered', () => {
-  cy.visitStory('AlertBar', 'Custom duration');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-When('the custom duration has passed', () => {
-  cy.wait(2000);
-});
-When('the default duration has passed', () => {
-  cy.wait(8000);
-});

package/build/es/alert-bar/features/hide/on_action.js

@@ -1,9 +0,0 @@
-import '../common/index.js';
-import { Given, When } from 'cypress-cucumber-preprocessor/steps';
-Given('a permanent AlertBar with actions is rendered', () => {
-  cy.visitStory('AlertBar', 'Permanent with actions');
-  cy.get('[data-test="dhis2-uicore-alertbar"]').should('be.visible');
-});
-When('the user clicks on the "Cancel" button', () => {
-  cy.get('[data-test="dhis2-uicore-alertbar-action"]:contains("Cancel")').click();
-});