fix(pfEmptyState): Ability for urlAction in empty state component #648
Conversation
test/views/empty-state.spec.js
Outdated
| expect(element.find('.blank-state-pf-helpLink').text()).toContain('For more information please see'); | ||
| expect(element.find('a').text()).toContain('pfExample'); | ||
| expect(element.find('a').prop('href')).toContain('#/api/patternfly.views.component:pfEmptyState'); | ||
| expect(element.find('.blank-state-pf-helpLink').click().length).toBe(1); |
There was a problem hiding this comment.
I think a better way to test callback functions in unit tests would be:
element.find('.blank-state-pf-helpLink').click();
expect($scope.eventText).toBe('Empty State Action Executed');
There was a problem hiding this comment.
Gotcha! I had something similar to that initially, thanks Dave! :)
src/views/empty-state.component.js
Outdated
| * <li>.info - (string) Text for the main informational paragraph | ||
| * <li>.helpLink - (object) Contains url specific properties and actions | ||
| * <ul style='list-style-type: none'> | ||
| * <li>.label - (string) Text for label |
There was a problem hiding this comment.
Perhaps "Text label which appears before the urlLabel
src/views/empty-state.component.js
Outdated
| * <li>.helpLink - (object) Contains url specific properties and actions | ||
| * <ul style='list-style-type: none'> | ||
| * <li>.label - (string) Text for label | ||
| * <li>.urlLabel - (string) Text for url label |
There was a problem hiding this comment.
How about: "Text for the clickable portion of the link"
There was a problem hiding this comment.
Still waiting on this minor fix. After these textual changes, everything LGTM.
amarie401
force-pushed
the
emptystate-filter
branch
2 times, most recently
from
0e55ffd to
241de6f
Compare
src/views/empty-state.component.js
Outdated
| * <ul style='list-style-type: none'> | ||
| * <li>.label - (string) Text label which appears before the | ||
| * <li>.urlLabel - (string) Text for the clickable portion of the link | ||
| * <li>.url - (string) Text for url path |
There was a problem hiding this comment.
This is optional, right?
There was a problem hiding this comment.
Yes this is optional.
src/views/empty-state.component.js
Outdated
| * <li>.label - (string) Text label which appears before the | ||
| * <li>.urlLabel - (string) Text for the clickable portion of the link | ||
| * <li>.url - (string) Text for url path | ||
| * <li>.urlAction - (function) Function to invoke a url action when a callback method is specified. |
There was a problem hiding this comment.
This is optional, right?
There was a problem hiding this comment.
Yes this is optional. Will make sure to note that.
There was a problem hiding this comment.
helpLink and it's properties are under the "config Optional configuration object" for the config param in ngDocs. Should I still note that it's optional? @jeff-phillips-18
There was a problem hiding this comment.
I would still mark them as optional for that object.
src/views/empty-state.component.js
Outdated
| if (ctrl.config.helpLink.urlAction) { | ||
| ctrl.config.helpLink.urlAction(); | ||
| } | ||
| }; |
There was a problem hiding this comment.
This is unnecessary. You can just use ng-click="$ctrl.config.helpLink.urlAction()", if it is not defined nothing will happen, no error.
amarie401
force-pushed
the
emptystate-filter
branch
4 times, most recently
from
ee4d4cf to
98b6f0e
Compare
| * <li>.helpLink - (object) Contains url specific properties and actions | ||
| * <ul style='list-style-type: none'> | ||
| * <li>.label - (string) Optional text label which appears before the | ||
| * <li>.urlLabel - (string) Optional text for the clickable portion of the link |
There was a problem hiding this comment.
How about "...before the urlLabel"
There was a problem hiding this comment.
Whoops that would be helpful huh? :)
amarie401
force-pushed
the
emptystate-filter
branch
from
98b6f0e to
f4a3811
Compare
cdcabrera
left a comment
cdcabrera
left a comment
There was a problem hiding this comment.
Looks good to me, simple and to the point!
4 participants
Description
Ability for pfEmptyState component config to have url action to provide a user defined callback method.
Specifically this will be helpful for this issue:
openshift/origin-web-catalog#461
Which would allow the clear applied filters function to be applied to the url link when a user clicks the link on the empty state. Currently only a url can be provided.
Rawgit
PR Checklist