Runs a list of functions, pausing between each one to ensure the component\n has had time to re-render.\n Ensure that you pass done into the test and that you call it at the end\n as this will make your tests asyncronous.
A simple helper method to check whether a node has a set of classNames on it.\n Will return true, only if a component is provided and it has all the classNames applied to it.
\nSimulate a user's keydown input
\nSimulate a user's keyup input
\nSimulate a user's keypress input
\nreturns true if and only if elem is invisible
returns true if and only if elem is visible
waitUntil is a testHelper to wait an arbitrary amount of time until a\ncondition is met.\nIt takes in a function (the condition of when to keep running) and returns a promise.\nThis is useful when you want to make changes to a component and then ensure that it has been\nrendered before performing any tests.\nWithin tests this is safe as they will automatically fail after 2000ms of not responding.
\nfunction | A list of functions to run in order. Each function is passed the return value of the last function (except for the last) |\n\n**JS Example**\n```js\nit('should respond to prop changes', (done) => {\n afterMutations(\n () => expect(component).to.be.in.some.state,\n () => props(component, {propName, propValue}),\n () => expect(component).to.be.in.another.state,\n () -> props(component, {propName, anotherValue}),\n () => expect(component).to.be.in.another.another.state,\n done\n );\n });\n```\n\n\n\n## hasClass(component, [...classes])\nA simple helper method to check whether a node has a set of classNames on it.\n Will return true, only if a component is provided and it has all the classNames applied to it.\n\n**Kind**: global function\n\n| Param | Type | Description |\n| --- | --- | --- |\n| component | Node | A node to check for classNames. |\n| [...classes] | String | A list of classNames to check for the existance of |\n\n**JS Example**\n```js\nconst elem = document.querySelector('.fixture').firstChild;\n const elemIsHidden = hasClass(elem, 'hidden');\n const elemIsSelectedAndHidden = hasClass(elem, 'hidden', 'selected');\n```\n\n\n\n## keydown(key, options)\nSimulate a user's keydown input\n\n**Kind**: global function\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | | – the key to press, will be passed to keycode |\n| options | Object | – options for the event. |\n| options.target | | – a DOM element to trigger the event on. Default:triggered on the document. |\n| options.eventProperties | Object | – properties to assign to the event (see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) |\n\n\n\n## keyup(key, options)\nSimulate a user's keyup input\n\n**Kind**: global function\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | | – the key to press, will be passed to keycode |\n| options | Object | – options for the event. |\n| options.target | | – a DOM element to trigger the event on. Default:triggered on the document. |\n| options.eventProperties | Object | – properties to assign to the event (see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) |\n\n\n\n## keypress(key, options)\nSimulate a user's keypress input\n\n**Kind**: global function\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | | – the key to press, will be passed to keycode |\n| options | Object | – options for the event. |\n| options.target | | – a DOM element to trigger the event on. Default:triggered on the document. |\n| options.eventProperties | Object | – properties to assign to the event (see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) |\n\n\n\n## checkInvisibility(elem)\nreturns true if and only if `elem` is invisible\n\n**Kind**: global function\n\n| Param | Description |\n| --- | --- |\n| elem | – the element to check |\n\n\n\n## checkVisibility(elem)\nreturns true if and only if `elem` is visible\n\n**Kind**: global function\n\n| Param | Description |\n| --- | --- |\n| elem | – the element to check |\n\n\n\n## waitUntil(fn, timeout, step)\nwaitUntil is a testHelper to wait an arbitrary amount of time until a\ncondition is met.\nIt takes in a function (the condition of when to keep running) and returns a promise.\nThis is useful when you want to make changes to a component and then ensure that it has been\nrendered before performing any tests.\nWithin tests this is safe as they will automatically fail after 2000ms of not responding.\n\n**Kind**: global function\n\n| Param | Description |\n| --- | --- |\n| fn | function that must return true when it is time for the promise to continue |\n| timeout | maximum amount of time waitUntil should wait before quiting (ms). |\n| step | amount of time to wait between checks of the `fn` condition (ms). |\n\n**JS Example**\n```js\nconst elem = document.querySelector('.fixture').firstChild;\n // We put name our condition function so we can re-use it a couple of times\n const elemRenderedImgTag = () => (elem.shadowRoot.querySelector('img') !== null);\n\n // check that no image is rendered before we start\n expect(elemRenderedImgTag()).to.equal(false);\n\n // set a property to make the image be rendered\n elem.showImage = true;\n\n // now wait until we can see the image rendered\n waitUntil(elemRenderedImgTag).then(() => (expect(elemRenderedImgTag()).to.equal(true)));\n\n // alternatively, we might want to do more things in the .then call, even chain more waitUntils\n\n waitUntil(elemRenderedImgTag).then(() => {\n expect(elemRenderedImgTag()).to.equal(true);\n doSomeMoreStuff(elem);\n return waitUntil(someOtherConditionIsTrue());\n }).then(() => {\n // Now we can do more stuff in here!\n });\n\n // You can also set a maximum amount of time to wait (and how long to wait in between attempts)\n waitUntil(elemRenderedImgTag, 1000, 10).then(() =>\n (expect(elemRenderedImgTag()).to.equal(true)));\n // this will check if the img was rendered every 10ms for up to a total of ~1 second.\n```\n\n_* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies._\n\n## We're here to help!\n\nLet us know what you think of our components and docs, your feedback is really important for us.\n\nAre you in trouble? Read through our [contribution guidelines](https://bitbucket.org/atlassian/atlaskit/src/HEAD/CONTRIBUTING.md) and raise an issue to us.\n\n","readmeFilename":"README.md"}