Skip to content
This repository has been archived by the owner on Jun 22, 2023. It is now read-only.

Document tile help button property and event #179

Merged
merged 2 commits into from
Dec 5, 2018
Merged

Document tile help button property and event #179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4aff6f6
Document tile help button property and event
blackbaud-johnly Dec 4, 2018
a4f827e
Update showHelp and showSettings descriptions
blackbaud-johnly Dec 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/app/components/tile/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,28 @@
>
Indicates whether the tile is in a collapsed state.
</sky-demo-page-property>
<sky-demo-page-property
propertyName="showHelp"
isOptional="true"
defaultValue="false"
>
Indicates whether to display a help button in the tile's header. To display the button, you must also listen for the <stache-code>helpClick</stache-code> event.
</sky-demo-page-property>
<sky-demo-page-property
propertyName="showSettings"
isOptional="true"
defaultValue="true"
>
Indicates whether to display the settings button on the tile.
Indicates whether to display a settings button on the tile. To display the button, you must also listen for the <stache-code>settingsClick</stache-code> event.
</sky-demo-page-property>
</sky-demo-page-properties>

<sky-demo-page-properties sectionHeading="Tile events">
<sky-demo-page-property
propertyName="helpClick"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably want to call out that you have to have both showHelp set to true and be listening to helpClick in order for the help icon to appear.

Settings works the same way.

>
Fires when users select the help button in the tile header. The help button only appears if the <stache-code>showHelp</stache-code> property is set to <stache-code>true</stache-code>.
</sky-demo-page-property>
<sky-demo-page-property
propertyName="isCollapsedChange"
>
Expand All @@ -35,7 +47,7 @@
<sky-demo-page-property
propertyName="settingsClick"
>
Fires when users select the settings button on the tile. The settings button only appears on the tile when the <stache-code>showSettings</stache-code> property is set to <stache-code>true</stache-code>.
Fires when users select the settings button on the tile. The settings button only appears if the <stache-code>showSettings</stache-code> property is set to <stache-code>true</stache-code>.
</sky-demo-page-property>
</sky-demo-page-properties>

Expand Down