Skip to content

Commit

Permalink
Rename chromeHidden to chromeless
Browse files Browse the repository at this point in the history
  • Loading branch information
eliperelman committed Nov 6, 2019
1 parent b9a7f95 commit c1482fb
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [chromeHidden](./kibana-plugin-public.appbase.chromehidden.md)
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [chromeless](./kibana-plugin-public.appbase.chromeless.md)

## AppBase.chromeHidden property
## AppBase.chromeless property

Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->.

<b>Signature:</b>

```typescript
chromeHidden?: boolean;
chromeless?: boolean;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface AppBase
| Property | Type | Description |
| --- | --- | --- |
| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
| [chromeHidden](./kibana-plugin-public.appbase.chromehidden.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. |
| [chromeless](./kibana-plugin-public.appbase.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. |
| [euiIconType](./kibana-plugin-public.appbase.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
| [icon](./kibana-plugin-public.appbase.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ How to configure react-router with a base path:
export class MyPlugin implements Plugin {
setup({ application }) {
application.register({
id: 'my-app',
async mount(context, params) {
const { renderApp } = await import('./application');
return renderApp(context, params);
},
});
id: 'my-app',
async mount(context, params) {
const { renderApp } = await import('./application');
return renderApp(context, params);
},
});
}
}

```
Expand Down
2 changes: 1 addition & 1 deletion src/core/public/application/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface AppBase {
/**
* Hide the UI chrome when the application is mounted. Defaults to `false`.
*/
chromeHidden?: boolean;
chromeless?: boolean;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/core/public/chrome/chrome_service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { App } from '../application';
class FakeApp implements App {
public title = `${this.id} App`;
public mount = () => () => {};
constructor(public id: string, public chromeHidden?: boolean) {}
constructor(public id: string, public chromeless?: boolean) {}
}
const store = new Map();
const originalLocalStorage = window.localStorage;
Expand Down Expand Up @@ -207,7 +207,7 @@ describe('start', () => {

it('application-specified visibility on mount', async () => {
const startDeps = defaultStartDeps([
new FakeApp('alpha'), // An undefined chromeHidden is the same as setting to false.
new FakeApp('alpha'), // An undefined `chromeless` is the same as setting to false.
new FakeApp('beta', true),
new FakeApp('gamma', false),
]);
Expand Down
4 changes: 2 additions & 2 deletions src/core/public/chrome/chrome_service.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export class ChromeService {
/**
* These observables allow consumers to toggle the chrome visibility via either:
* 1. Using setIsVisible() to trigger the next chromeHidden$
* 2. Setting `chromeHidden` when registering an application, which will
* 2. Setting `chromeless` when registering an application, which will
* reset the visibility whenever the next application is mounted
* 3. Having embed=true in the query string
*/
Expand All @@ -113,7 +113,7 @@ export class ChromeService {
appId =>
!!appId &&
application.availableApps.has(appId) &&
!!application.availableApps.get(appId)!.chromeHidden
!!application.availableApps.get(appId)!.chromeless
)
)
);
Expand Down
2 changes: 1 addition & 1 deletion src/core/public/public.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface App extends AppBase {
// @public (undocumented)
export interface AppBase {
capabilities?: Partial<Capabilities>;
chromeHidden?: boolean;
chromeless?: boolean;
euiIconType?: string;
icon?: string;
// (undocumented)
Expand Down

0 comments on commit c1482fb

Please sign in to comment.