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

Commit

Permalink
Document tile help button property and event (#179)
Browse files Browse the repository at this point in the history
* Document tile help button property and event

* Update showHelp and showSettings descriptions
  • Loading branch information
blackbaud-johnly authored Dec 5, 2018
1 parent f229636 commit 132ff68
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/app/components/tile/index.html
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"
>
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

0 comments on commit 132ff68

Please sign in to comment.