Skip to content

chore(@inboxsdk/core@1.2.1): add new methods #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2023
Merged

chore(@inboxsdk/core@1.2.1): add new methods #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/appmenu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ If the `insertOrder` option is provided, the app menu item will be added at that

_Returns_ an `AppMenuItemView`

#### isMenuOpen

_Returns_ whether or not the AppMenu Burger is uncollapsed or not.

### Properties

| Property | Type | Description | Required? | Default |
| :--------- | :------- | :------------------------------------------------- | :-------- | :------ |
| **events** | `Events` | A kefir stream of events related to the namespace. | | |

### Events

#### collapseToggled

The TransitionEvent that was fired when the AppMenu's collapsiblepanel toggle collapsed or open started, canceled, or ended. `transactionstart` and `transitioncancel` are currently fired. We also theoretically handle `transactionend`, but it isn't currently fired.

---

## AppMenuItemView
Expand Down
3 changes: 3 additions & 0 deletions docs/navmenu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ Collapse or uncollapse this NavItemView
| :--- | :--- | :--- |
| **collapseValue** | `boolean` | whether to collapse or uncollapse |

#### getElement()
_Returns_ the underlying HTMLElement for the `NavItemView`.


### Events
#### destroy
Expand Down