Skip to content

Commit

Permalink
[PBIOS-292] User Presence Docs (#3200)
Browse files Browse the repository at this point in the history
**What does this PR do?** A clear and concise description with your
runway ticket url.
[PBIOS-292] User Presence Docs

**Screenshots:** Screenshots to visualize your addition/change


**How to test?** Steps to confirm the desired behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See addition/change


#### Checklist:
- [x] **LABELS** Add a label: `enhancement`, `bug`, `improvement`, `new
kit`, `deprecated`, or `breaking`. See [Changelog &
Labels](https://github.com/powerhome/playbook/wiki/Changelog-&-Labels)
for details.
- [x] **DEPLOY** I have added the `milano` label to show I'm ready for a
review.
- [x] **TESTS** I have added test coverage to my code.

---------

Co-authored-by: Jason Cypret <jason@jasoncypret.com>
Co-authored-by: Colin Lewis <112719604+co1in-1ewis@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 11, 2024
1 parent 83f29c3 commit 4bf3ab6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
![user-presence-indicator)](https://github.com/powerhome/playbook/assets/112719604/96ee8408-2e21-4aaf-ae65-9f023515cf8d)

```swift
VStack(alignment: .leading, spacing: Spacing.small) {
PBUser(
name: name,

image: img,
size: .small,
territory: "PHL",
title: title,
status: .online
)
PBUser(
name: name,
image: img,
territory: "PHL",
title: title,
status: .away
)
PBUser(
name: name,
image: img,
size: .large,
territory: "PHL",
title: title,
status: .offline
)
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
| **orientation** | `Orientation` | Changes the orientation of the User | `.horizontal` | `.horizontal` `.verticle` |
| **size** | `UserAvatarSize` | Changes the size of the User | `.medium` | `.small` `.medium` `.large` |
| **territory** | `String` | Adds the User's territory | | |
| **title** | `String` | Adds a title | | |
| **title** | `String` | Adds a title | | |
| **status** | `PBAvatar.PresenceStatus?` | An idicator for the current status of the user | `.none` | `.online` `.away` `.offline` |
1 change: 1 addition & 0 deletions playbook/app/pb_kits/playbook/pb_user/docs/example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ examples:
- user_vertical_size_swift: Vertical
- user_text_only_swift: Text Only
- user_size_swift: Horizontal Size
- user_presence_indicator_swift: Presence Indicator
- user_props_table: ""

0 comments on commit 4bf3ab6

Please # to comment.