Bottom Drawer

Bottom Drawer WebComponent / StencilJS / Ionic 6

|

Installation

$ npm i @zoff-tech/zt-bottom-drawer

Properties

| Property | Attribute | Description | Type | Default | | -------------------- | ----------------------- | ----------- | --------- | ------------------------------------------------- | | allowScroll | allow-scroll | | boolean | true | | coefAnimationTime | coef-animation-time | | number | 40 | | disableGesture | disable-gesture | | boolean | false | | fixCurrentPosition | fix-current-position | | boolean | false | | hidden | hidden | | boolean | false | | hideOnPositionZero | hide-on-position-zero | | boolean | false | | positionName | position-name | | string | undefined | | positions | positions | | string | "close-b-10,bottom-b-200,middle-b-450,top-t-60" |

Events

| Event | Description | Type | | ----------------------- | ----------- | ------------------------------------------------------------------------------------------------------ | | ztChangePositionEvent | | CustomEvent<{ positionName: string; lastPositionName: string; htmlElements: ZTHTMLElementsDrawer; }> | | ztHideEvent | | CustomEvent<{ drawer: HTMLElement; gestureTarget: HTMLElement; content: HTMLElement; }> | | ztNavDidChange | | CustomEvent<any> | | ztNavWillChange | | CustomEvent<any> |

Methods

getActiveComponentTagName() => Promise<string>

Returns

Type: Promise<string>

getCurrentIndex() => Promise<number>

Returns

Type: Promise<number>

getCurrrentPositionDto() => Promise<ZTPositionDrawer>

Returns

Type: Promise<ZTPositionDrawer>

getNav() => Promise<HTMLIonNavElement>

Returns

Type: Promise<HTMLIonNavElement>

getNavActive() => Promise<ViewController>

Returns

Type: Promise<ViewController>

getNavCurrentComponent() => Promise<any>

Returns

Type: Promise<any>

getPositionByIndex(index: number) => Promise<ZTPositionDrawer>

Returns

Type: Promise<ZTPositionDrawer>

getPositionByName(name: string) => Promise<ZTPositionDrawer>

Returns

Type: Promise<ZTPositionDrawer>

goBack(amountBack?: number, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<Boolean>

Returns

Type: Promise<Boolean>

goBackToIndex(index: number, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<Boolean>

Returns

Type: Promise<Boolean>

goBackToRoot(opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<Boolean>

Returns

Type: Promise<Boolean>

hide() => Promise<void>

Returns

Type: Promise<void>

pushNav(component: string | HTMLElement, propsComponent: any, options: PushNavOptions) => Promise<boolean>

Returns

Type: Promise<boolean>

refreshSizeContent() => Promise<void>

Returns

Type: Promise<void>

saveStateInActiveComponent() => Promise<void>

Returns

Type: Promise<void>

setPosition(value: ZTPositionDrawer, force?: boolean) => Promise<void>

Returns

Type: Promise<void>

setPositionByName(name: string, force?: boolean) => Promise<void>

Returns

Type: Promise<void>

setScrollToTop(duration?: number) => Promise<void>

Returns

Type: Promise<void>

setTranslateY(posY: number, applyAnimation?: boolean) => Promise<void>

Returns

Type: Promise<void>

show(positionName: string) => Promise<void>

Returns

Type: Promise<void>

Dependencies

Depends on

• ion-nav

Graph

graph TD;
  zt-bottom-drawer --> ion-nav
  style zt-bottom-drawer fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS

Examples

See in repository.

License

The MIT License (MIT)

Copyright (c) 2021 Rodrigo Zoff

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.