Skip to content

Commit

Permalink
more information on the application layout
Browse files Browse the repository at this point in the history
  • Loading branch information
piggydoughnut committed May 30, 2024
1 parent f4f7f55 commit 2be990b
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 68 deletions.
156 changes: 88 additions & 68 deletions documentation/pages/framework/configuration/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,13 @@ Authentication providers are also defined here under `auth.providers`. The defau
},
"layout": {
"mobile": {
"fixed": [["users", "NewjoinerDetector"]],
"fixed": [
["users", "NewjoinerDetector"],
["users", "UserStatus"]
],
"office": [
["events", "UncompletedActions"],
["events", "MyEvents"],
["quick-navigation", "QuickNav"],
["users", "UsersMapWidget", { "offices": ["global"] }],
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
Expand Down Expand Up @@ -50,39 +55,60 @@ Authentication providers are also defined here under `auth.providers`. The defau

```

### Widget configuration

```
["users", "UsersMapWidget", { "offices": ["global"] }],
```

This configuration only shows widget `UsersMapWidget` from the `users` module in the office with id `global`

```
["news", "LatestNews"]
```

Widget `LatestNews` from module `news` is displayed in all hubs.
## Mobile

```
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
```json
"mobile": {
"fixed": [
["users", "NewjoinerDetector"],
["users", "UserStatus"]
],
"office": [
["events", "UncompletedActions"],
["events", "MyEvents"],
["quick-navigation", "QuickNav"],
["users", "UsersMapWidget", { "offices": ["global"] }],
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
],
"events": [["events", "UpcomingEvents"]],
"news": [["news", "LatestNews"]]
},
```

Widget `AboutWidget` from module `about` is displayed in `berlin`, `lisbon` and `london` hubs.
`fixed` - items above the call to action widget (Visit office, Book a Room, Invite a Guest)

`office`, `events`, `news` tabs are configurable.

<div style="display: flex; column-gap: 10px; align-items: flex-end">
<Image
src="/mobileOffice.png"
alt="mobile office"
width="250"
height="200"
style="border: 1px solid lightGray; border-radius: 10px; margin-top: 10px"
/>

<Image
src="/mobileEvents.png"
alt="mobile events"
width="250"
height="200"
style="border: 1px solid lightGray; border-radius: 10px; margin-top: 10px"
/>

<Image
src="/mobileNews.png"
alt="mobile news"
width="250"
height="200"
style="border: 1px solid lightGray; border-radius: 10px; margin-top: 10px"
/>

</div>

## Desktop

You can choose between 3 and 2 column layout.

### 3 col layout

<Image src="/layout-3col.png" alt="Layout-3" width={600} height={650} />

In order to configure 3 columns populate "sidebar", "main" and "sidebarRight" with your configuration.

E.g

```
```json
"desktop": {
"sidebar": [
["quick-navigation", "QuickNav"],
Expand All @@ -96,62 +122,56 @@ E.g
{ "offices": ["berlin", "lisbon", "london"] }
]
],
[["users", "UsersMapWidget", { "offices": ["global"] }]]
[["hub-map", "HubMap"]],
],
"sidebarRight": [
[["announcements", "Announcement"]],
[["users", "UsersMapWidget", { "offices": ["global"] }]],
[
["events", "UpcomingEvents"],
["news", "LatestNews"]
]
],
"sidebarRight": [
["events", "MyEvents"],
["events", "UpcomingEvents"],
["news", "LatestNews"]
]
}

```

<Image
src="/desktopLayout.png"
alt="desktop layout"
style="border: 1px solid lightGray; border-radius: 10px; margin-top: 10px"
/>
You can choose between 3 and 2 column layout.

### 3 col layout

In order to configure 3 columns populate `sidebar`, `main` and `sidebarRight` with your configuration.

<Image src="/layout-3col.png" alt="Layout-3" width={600} height={650} />

### 2 col layout

For the 2 column layout populate `sidebar` and `main` only.
<Image src="/layout-2col.png" alt="Layout-2" width={600} height={650} />

For the 2 column layout populate "sidebar" and "main" only.
### Widget configuration

E.g
```
["users", "UsersMapWidget", { "offices": ["global"] }],
```

This configuration only shows widget `UsersMapWidget` from the `users` module in the office with id `global`

```
"desktop": {
"sidebar": [
["quick-navigation", "QuickNav"],
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
],
"main": [
[
[
"office-visits",
"Actions",
{ "offices": ["berlin", "lisbon", "london"] }
]
],
[["users", "UsersMapWidget", { "offices": ["global"] }]]
[["hub-map", "HubMap"]],
// the folllowing two modules will split the space between them under the HubMap
[
["events", "UpcomingEvents"],
["news", "LatestNews"]
]
]
}
["news", "LatestNews"]
```

## Mobile
Widget `LatestNews` from module `news` is displayed in all hubs.

```
"mobile": {
"fixed": [["users", "NewjoinerDetector"]],
"office": [
["quick-navigation", "QuickNav"],
["users", "UsersMapWidget", { "offices": ["global"] }],
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
],
"events": [["events", "UpcomingEvents"]],
"news": [["news", "LatestNews"]]
},
["about", "AboutWidget", { "offices": ["berlin", "lisbon", "london"] }]
```

`office`, `events`, `news` are the 3 tabs in the mobile view. You can configure what to show for each of them.
Widget `AboutWidget` from module `about` is displayed in `berlin`, `lisbon` and `london` hubs.
11 changes: 11 additions & 0 deletions documentation/pages/modules/visits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Visits module

This module takes care of desk bookings.

## Available Widgets

This module provides functionality for desk booking but does not have specific desk booking widgets, as they are part of the booking flow, which start when user uses [Office vists module](./office-visits.md).

### Who is in Office

To enable - add `["visits", "WhoIsInOffice", { "offices": ["berlin", "lisbon", "london"] }]` in the [application.json](../framework/configuration/application.md) configuration.
Binary file added documentation/public/desktopLayout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/public/mobileEvents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/public/mobileNews.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/public/mobileOffice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2be990b

Please sign in to comment.