
@hugotomazi/capacitor-navigation-bar
5 | Capacitor plugin for Navigation Bar manipulation. 6 |
7 | 8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
25 |
26 |
ColorParameters |
100 |
101 | --------------------
102 |
103 |
104 | ### setTransparency(...)
105 |
106 | ```typescript
107 | setTransparency(options: { isTransparent: boolean; }) => Promise{ isTransparent: boolean; } |
115 |
116 | --------------------
117 |
118 |
119 | ### getColor()
120 |
121 | ```typescript
122 | getColor() => Promise<{ color: string; }>
123 | ```
124 |
125 | Gets the current color of the navigation bar in Hexadecimal.
126 |
127 | **Returns:** Promise<{ color: string; }>
128 |
129 | --------------------
130 |
131 |
132 | ### addListener(...)
133 |
134 | ```typescript
135 | addListener(event: NavigationBarPluginEvents.SHOW, listenerFunc: () => void) => PromiseNavigationBarPluginEvents.SHOW | The event |
143 | | **`listenerFunc`** | () => void | Callback |
144 |
145 | **Returns:** Promise<PluginListenerHandle>
146 |
147 | --------------------
148 |
149 |
150 | ### addListener(...)
151 |
152 | ```typescript
153 | addListener(event: NavigationBarPluginEvents.HIDE, listenerFunc: () => void) => PromiseNavigationBarPluginEvents.HIDE | The event |
161 | | **`listenerFunc`** | () => void | Callback |
162 |
163 | **Returns:** Promise<PluginListenerHandle>
164 |
165 | --------------------
166 |
167 |
168 | ### addListener(...)
169 |
170 | ```typescript
171 | addListener(event: NavigationBarPluginEvents.COLOR_CHANGE, listenerFunc: (returnObject: { color: string; }) => void) => PromiseNavigationBarPluginEvents.COLOR_CHANGE | The event |
179 | | **`listenerFunc`** | (returnObject: { color: string; }) => void | Callback |
180 |
181 | **Returns:** Promise<PluginListenerHandle>
182 |
183 | --------------------
184 |
185 |
186 | ### Interfaces
187 |
188 |
189 | #### ColorParameters
190 |
191 | | Prop | Type | Description |
192 | | ----------------- | -------------------- | ------------------------------------------------------------------------- |
193 | | **`color`** | string | Sets the new color of the navigation bar. |
194 | | **`darkButtons`** | boolean | Sets whether the default navigation bar buttons should be black or white. |
195 |
196 |
197 | #### PluginListenerHandle
198 |
199 | | Prop | Type |
200 | | ------------ | ----------------------------------------- |
201 | | **`remove`** | () => Promise<void> |
202 |
203 |
204 | ### Enums
205 |
206 |
207 | #### NavigationBarPluginEvents
208 |
209 | | Members | Value | Description |
210 | | ------------------ | ---------------------------- | -------------------------------------------- |
211 | | **`SHOW`** | 'onShow' | Called after the navigation bar is displayed |
212 | | **`HIDE`** | 'onHide' | Called after navigation bar is hidden |
213 | | **`COLOR_CHANGE`** | 'onColorChange' | Called after navigation bar color is changed |
214 |
215 |