Skip to content

Commit 7025b22

Browse files
authored
Merge pull request #10 from lumapps/chore/fixes
chore(fixes): API table
2 parents 014002e + 0880e16 commit 7025b22

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

docs/javascript/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ And `configuration` is an object that allows these properties:
7878
| `targets.SUB_NAVIGATION_UI` | Target id for the sub navigation's UI. | [Documentation](./capabilities#sub-navigation-ui) |
7979
| `targets.WIDGET` | Target id for a widget. | [Documentation](./capabilities#widget) |
8080
| `targets.USER_DIRECTORY` | Target id for the user directory. | [Documentation](./capabilities#user-directory) |
81+
| `targets.USER_PROFILE_ORG_CHART` | Target id for the user profile orgnaization chart | [Documentation](./capabilities#organization-chart) |
8182

8283
#### widget target
8384

docs/javascript/capabilities.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ Target that allows customizing the settings icon displayed on the top bar.
499499

500500
- [Adding new actions on the top bar](./use-cases#adding-new-actions-on-the-top-bar)
501501

502-
### Settings dropdown
502+
### Settings
503503

504504
Target that allows customizing the settings links displayed on the dropdown triggered by the settings button.
505505

@@ -509,19 +509,38 @@ Target that allows customizing the settings links displayed on the dropdown trig
509509

510510
| | |
511511
|---------------|------------------------------------------------------------------------------------------------------------------|
512-
| Target ID | `profile` |
513-
| Description | Target the user profile page. |
514-
| Placements | Compatible with placements: `ABOVE`, `UNDER`. Customizations will be added as siblings of the user profile page. |
512+
| Target ID | `settings` |
513+
| Description | Target the settings dropdown. |
514+
| Placements | Compatible with placements: `ABOVE`, `UNDER`. |
515515
| Disable | No compatibility |
516516
| Changing text | No compatibility |
517517

518-
519518
**Note:** Customizations added to this target will only be visible to those users that have access to one of the multiple settings displayed on the dropdown. If a user does not have access to this icon, the customizations will not be displayed
520519

521520
#### Use cases
522521

523522
- [Add links to other administration tools](./use-cases#add-links-to-other-administration-tools)
524523

524+
### Profile
525+
526+
Target that allows customizing a user's profile page.
527+
528+
![Target profile](./assets/target-profile.png "Target profile")
529+
530+
#### Compatibility
531+
532+
| | |
533+
|---------------|------------------------------------------------------------------------------------------------------------------|
534+
| Target ID | `profile` |
535+
| Description | Target the user profile page. |
536+
| Placements | Compatible with placements: `ABOVE`, `UNDER`. Customizations will be added as siblings of the user profile page. |
537+
| Disable | No compatibility |
538+
| Changing text | No compatibility |
539+
540+
#### Use cases
541+
542+
- [Display a message above all pages of a certain type](./use-cases#display-a-message-above-all-pages-of-a-certain-type)
543+
525544
### Sticky header
526545

527546
Target that allows deactivating that your site's header has a sticky behaviour, meaning that it will stick to the top of your page while the user is scrolling.
@@ -535,7 +554,7 @@ Target that allows deactivating that your site's header has a sticky behaviour,
535554
| Target ID | `sticky-header` |
536555
| Description | Target that allows disabling the sticky header * |
537556
| Placements | No compatibility |
538-
| Disable | No compatibility |
557+
| Disable | Can be disabled. * |
539558
| Changing text | No compatibility |
540559

541560
**Note**: some extra CSS needs to be added in order to make this customization have the expected result

0 commit comments

Comments
 (0)