navbar.d.ts 2.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. import { ElementRef, Renderer } from '@angular/core';
  2. import { App } from '../app/app';
  3. import { Config } from '../../config/config';
  4. import { NavController } from '../../navigation/nav-controller';
  5. import { ToolbarBase } from './toolbar-base';
  6. import { ViewController } from '../../navigation/view-controller';
  7. /**
  8. * @name Navbar
  9. * @description
  10. * Navbar acts as the navigational toolbar, which also comes with a back
  11. * button. A navbar can contain a `ion-title`, any number of buttons,
  12. * a segment, or a searchbar. Navbars must be placed within an
  13. * `<ion-header>` in order for them to be placed above the content.
  14. * It's important to note that navbar's are part of the dynamic navigation
  15. * stack. If you need a static toolbar, use ion-toolbar.
  16. *
  17. * @usage
  18. * ```html
  19. * <ion-header>
  20. *
  21. * <ion-navbar>
  22. * <button ion-button icon-only menuToggle>
  23. * <ion-icon name="menu"></ion-icon>
  24. * </button>
  25. *
  26. * <ion-title>
  27. * Page Title
  28. * </ion-title>
  29. *
  30. * <ion-buttons end>
  31. * <button ion-button icon-only (click)="openModal()">
  32. * <ion-icon name="options"></ion-icon>
  33. * </button>
  34. * </ion-buttons>
  35. * </ion-navbar>
  36. *
  37. * </ion-header>
  38. * ```
  39. *
  40. * @demo /docs/demos/src/navbar/
  41. * @see {@link ../../toolbar/Toolbar/ Toolbar API Docs}
  42. */
  43. export declare class Navbar extends ToolbarBase {
  44. _app: App;
  45. private navCtrl;
  46. /**
  47. * @hidden
  48. */
  49. _backText: string;
  50. /**
  51. * @hidden
  52. */
  53. _bbIcon: string;
  54. /**
  55. * @hidden
  56. */
  57. _hidden: boolean;
  58. /**
  59. * @hidden
  60. */
  61. _hideBb: boolean;
  62. /**
  63. * @hidden
  64. */
  65. _sbPadding: boolean;
  66. /**
  67. * @input {boolean} If true, the back button will be hidden.
  68. */
  69. hideBackButton: boolean;
  70. constructor(_app: App, viewCtrl: ViewController, navCtrl: NavController, config: Config, elementRef: ElementRef, renderer: Renderer);
  71. backButtonClick(ev: UIEvent): void;
  72. /**
  73. * Set the text of the Back Button in the Nav Bar. Defaults to "Back".
  74. */
  75. setBackButtonText(text: string): void;
  76. /**
  77. * @hidden
  78. */
  79. didEnter(): void;
  80. /**
  81. * @hidden
  82. */
  83. setHidden(isHidden: boolean): void;
  84. }