diff --git a/packages/core/src/components.d.ts b/packages/core/src/components.d.ts index 53ec8c7ab2..d7323bc9bf 100644 --- a/packages/core/src/components.d.ts +++ b/packages/core/src/components.d.ts @@ -1926,6 +1926,40 @@ declare global { } +import { + Navbar as IonNavbar +} from './components/navbar/navbar'; + +declare global { + interface HTMLIonNavbarElement extends IonNavbar, HTMLElement { + } + var HTMLIonNavbarElement: { + prototype: HTMLIonNavbarElement; + new (): HTMLIonNavbarElement; + }; + interface HTMLElementTagNameMap { + "ion-navbar": HTMLIonNavbarElement; + } + interface ElementTagNameMap { + "ion-navbar": HTMLIonNavbarElement; + } + namespace JSX { + interface IntrinsicElements { + "ion-navbar": JSXElements.IonNavbarAttributes; + } + } + namespace JSXElements { + export interface IonNavbarAttributes extends HTMLAttributes { + + hideBackButton?: boolean, + backButtonText?: string, + backButtonIcon?: string, + hidden?: boolean + } + } +} + + import { Note as IonNote } from './components/note/note'; @@ -3292,40 +3326,6 @@ declare global { } -import { - Navbar as IonNavbar -} from './components/toolbar/navbar'; - -declare global { - interface HTMLIonNavbarElement extends IonNavbar, HTMLElement { - } - var HTMLIonNavbarElement: { - prototype: HTMLIonNavbarElement; - new (): HTMLIonNavbarElement; - }; - interface HTMLElementTagNameMap { - "ion-navbar": HTMLIonNavbarElement; - } - interface ElementTagNameMap { - "ion-navbar": HTMLIonNavbarElement; - } - namespace JSX { - interface IntrinsicElements { - "ion-navbar": JSXElements.IonNavbarAttributes; - } - } - namespace JSXElements { - export interface IonNavbarAttributes extends HTMLAttributes { - - hideBackButton?: boolean, - backButtonText?: string, - backButtonIcon?: string, - hidden?: boolean - } - } -} - - import { Toolbar as IonToolbar } from './components/toolbar/toolbar'; diff --git a/packages/core/src/components/toolbar/navbar.tsx b/packages/core/src/components/navbar/navbar.tsx similarity index 69% rename from packages/core/src/components/toolbar/navbar.tsx rename to packages/core/src/components/navbar/navbar.tsx index 1c6491c48a..96d8962162 100644 --- a/packages/core/src/components/toolbar/navbar.tsx +++ b/packages/core/src/components/navbar/navbar.tsx @@ -3,42 +3,6 @@ import { createThemedClasses } from '../../utils/theme'; import { Config } from '../../index'; -/** - * @name Navbar - * @description - * Navbar acts as the navigational toolbar, which also comes with a back - * button. A navbar can contain a `ion-title`, any number of buttons, - * a segment, or a searchbar. Navbars must be placed within an - * `` in order for them to be placed above the content. - * It's important to note that navbar's are part of the dynamic navigation - * stack. If you need a static toolbar, use ion-toolbar. - * - * @usage - * ```html - * - * - * - * - * - * - * - * - * Page Title - * - * - * - * - * - * - * - * - * - * - * ``` - * - * @demo /docs/demos/src/navbar/ - * @see {@link ../../toolbar/Toolbar/ Toolbar API Docs} - */ @Component({ tag: 'ion-navbar', host: { diff --git a/packages/core/src/components/navbar/readme.md b/packages/core/src/components/navbar/readme.md new file mode 100644 index 0000000000..3bb2f61fd5 --- /dev/null +++ b/packages/core/src/components/navbar/readme.md @@ -0,0 +1,83 @@ +# ion-navbar + +Navbar acts as the navigational toolbar, which also comes with a back +button. A navbar can contain a `ion-title`, any number of buttons, +a segment, or a searchbar. Navbars must be placed within an +`` in order for them to be placed above the content. +It's important to note that navbar's are part of the dynamic navigation +stack. If you need a static toolbar, use ion-toolbar. + +```html + + + + + + + + + Page Title + + + + + + + + + + +``` + + + + + +## Properties + +#### backButtonIcon + +string + + +#### backButtonText + +string + + +#### hidden + +boolean + + +#### hideBackButton + +boolean + + +## Attributes + +#### backButtonIcon + +string + + +#### backButtonText + +string + + +#### hidden + +boolean + + +#### hideBackButton + +boolean + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/toolbar/readme.md b/packages/core/src/components/toolbar/readme.md index 1eb91d4945..d94dc00fd7 100644 --- a/packages/core/src/components/toolbar/readme.md +++ b/packages/core/src/components/toolbar/readme.md @@ -87,44 +87,34 @@ attribute to the element. ## Properties -#### backButtonIcon +#### color string -#### backButtonText +#### mode -string +any -#### hidden - -boolean - - -#### hideBackButton +#### translucent boolean ## Attributes -#### backButtonIcon +#### color string -#### backButtonText +#### mode -string +any -#### hidden - -boolean - - -#### hideBackButton +#### translucent boolean diff --git a/packages/core/src/index.d.ts b/packages/core/src/index.d.ts index 7d04a9d4ad..d76ea76570 100644 --- a/packages/core/src/index.d.ts +++ b/packages/core/src/index.d.ts @@ -86,6 +86,7 @@ export { export { ModalController } from './components/modal-controller/modal-controller'; export { Nav } from './components/nav/nav'; export { PublicNav } from './components/nav/nav-interface'; +export { Navbar } from './components/navbar/navbar'; export { NavController } from './components/nav-controller/nav-controller'; export { Note } from './components/note/note'; export { Page } from './components/page/page'; @@ -146,7 +147,6 @@ export { } from './components/toast/toast'; export { ToastController } from './components/toast-controller/toast-controller'; export { Toggle } from './components/toggle/toggle'; -export { Navbar } from './components/toolbar/navbar'; export { Toolbar } from './components/toolbar/toolbar'; export * from './navigation/nav-interfaces';