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

Commit

Permalink
Repeater updates (#216)
Browse files Browse the repository at this point in the history
* added isExpanded property

* added default value

* added footer

* added missing properties

* Doc tweaks
  • Loading branch information
Blackbaud-DeniseCisneros authored and blackbaud-johnly committed Jan 24, 2019
1 parent 5e8458d commit 6d9a239
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
5 changes: 5 additions & 0 deletions skyuxconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@
"host": {
"url": "https://developer.blackbaud.com"
},
"app": {
"title": "Blackbaud SKY UX"
},
"appSettings": {
"stache": {
"editButton": {
"text": "Suggest edit",
"url": "https://github.com/blackbaud/skyux2-docs"
},
"footer": {
},
"searchConfig": {
"is_internal": false
}
Expand Down
35 changes: 21 additions & 14 deletions src/app/components/repeater/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,49 @@
>

<sky-demo-page-summary>
The repeater component creates a container to display information for a list of objects. As an alternative to a grid layout, repeaters are particularly effective for mobile-intensive contexts and other scenarios that require the compact display of information.
The repeater component creates a container to display information for a list of objects. A repeater list is particularly effective as an alternative to a grid layout in mobile-intensive contexts and other scenarios that require the compact display of information. Within the <stache-code>sky-repeater</stache-code> component, the <stache-code>sky-repeater-item</stache-code> component creates individual repeater items. Within the repeater items, the <stache-code>sky-repeater-item-title</stache-code> component displays a header, the <stache-code>sky-repeater-item-content</stache-code> component displays content text when the repeater is expanded, and the <stache-code>sky-repeater-item-context-menu</stache-code> wraps and styles <a stacheRouterLink="/components/dropdown">a <stache-code>sky-dropdown</stache-code> component</a>.
</sky-demo-page-summary>

<sky-demo-page-properties>
<sky-demo-page-properties sectionHeading="Repeater properties">
</sky-demo-page-property>
<sky-demo-page-property
propertyName="expandMode"
defaultValue="none"
isOptional="true"
>
Specifies a layout for the repeater list to indicate whether users can collapse and expand repeater items. Items in a collapsed state display titles only. The valid options are <stache-code>none</stache-code>, <stache-code>multiple</stache-code>, and <stache-code>single</stache-code>.
Specifies a layout for the repeater list to indicate whether users can collapse and expand repeater items. Items in a collapsed state display titles only. The valid options are <stache-code>multiple</stache-code>, <stache-code>none</stache-code>, and <stache-code>single</stache-code>. <i>(Default: none)</i>
<ul>
<li>
<stache-code>none</stache-code> loads all repeater items in an expanded state and does not allow users to collapse them. This standard layout provides the quickest access to the details in the repeater items. It is best-suited to repeater items with concise content that users need to view frequently.
<stache-code>multiple</stache-code> loads all repeater items in a collapsed state and allows users to expand and collapse them. This layout provides a more compact view but still allows users to expand as many repeater items as necessary. It is best-suited to repeater items where the most important information is in the titles and users only occasionally need to view body content.
</li>
<li>
<stache-code>multiple</stache-code> loads all repeater items in a collapsed state and allow users to expand and collapse them. This layout provides a more compact view but still allows users to expand as many repeater items as necessary. It is best-suited to repeater items where the most important information is in the titles and users only occasionally need to view body content.
<stache-code>none</stache-code> loads all repeater items in an expanded state and does not allow users to collapse them. This standard layout provides the quickest access to the details in the repeater items. It is best-suited to repeater items with concise content that users need to view frequently.
</li>
<li>
<stache-code>single</stache-code> loads all repeater items in a collapsed state and allow users to expand one item at a time. This layout provides the most compact view because users can only expand one repeater item at a time. It is best-suited to repeater items where the most important information is in the titles and users only occasionally need to view body content of one repeater item at a time.
<stache-code>single</stache-code> loads all repeater items in a collapsed state and allows users to expand one item at a time. This layout provides the most compact view because users can only expand one repeater item at a time. It is best-suited to repeater items where the most important information is in the titles and users only occasionally need to view the body content of one repeater item at a time.
</li>
</ul>
</sky-demo-page-property>

</sky-demo-page-properties>
<sky-demo-page-properties sectionHeading="Repeater item properties">
<sky-demo-page-property
propertyName="selectable"
defaultValue="false"
propertyName="isExpanded"
isOptional="true"
defaultValue="true"
>
Indicates whether to display a checkbox in the left of the repeater item.
Indicates whether the repeater item is expanded. This property accepts <stache-code>boolean</stache-code> values.
</sky-demo-page-property>

<sky-demo-page-property
propertyName="isSelected"
isOptional="true"
defaultValue="false"
>
Indicates whether the repeater item's checkbox is selected. When users select the repeater item, the specified property on your model is updated accordingly. This property accepts <stache-code>boolean</stache-code> values.
</sky-demo-page-property>
<sky-demo-page-property
propertyName="selectable"
defaultValue="false"
isOptional="true"
>
Specifies whether the repeater item is selected (i.e. its checkbox is checked). When the user selects the repeater item the specified property on your model will be updated accordingly.
Indicates whether to display a checkbox in the left of the repeater item. This property accepts <stache-code>boolean</stache-code> values.
</sky-demo-page-property>

<sky-demo-page-property
Expand Down

0 comments on commit 6d9a239

Please sign in to comment.