mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
de0e1eb0d4
## Summary Closes #162263 Introduces a new `Feature Privileges` section to the developer documentation. The documentation includes a tutorial on how to control access to features of plugin being developed. Introduces a few sections: - Controlling access to UI features - Controlling access to server side APIs - Documentation for configuration options ## Testing To build this locally, run ./scripts/dev_docs from a local checkout of this PR. A server will eventually start on http://localhost:3000 where you can preview the changes. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
59 lines
2.2 KiB
TypeScript
59 lines
2.2 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
|
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
|
* Side Public License, v 1.
|
|
*/
|
|
import React from 'react';
|
|
import ReactDOM from 'react-dom';
|
|
import { AppMountParameters, CoreSetup, CoreStart, Plugin } from '@kbn/core/public';
|
|
import { DeveloperExamplesSetup } from '@kbn/developer-examples-plugin/public';
|
|
import { SecurityPluginSetup, SecurityPluginStart } from '@kbn/security-plugin/public';
|
|
import { KibanaPageTemplate } from '@kbn/shared-ux-page-kibana-template';
|
|
import type { FeaturesPluginSetup } from '@kbn/features-plugin/public';
|
|
import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
|
|
import { MyPluginComponent } from './app';
|
|
|
|
interface SetupDeps {
|
|
developerExamples: DeveloperExamplesSetup;
|
|
security: SecurityPluginSetup;
|
|
features: FeaturesPluginSetup;
|
|
}
|
|
|
|
interface StartDeps {
|
|
security: SecurityPluginStart;
|
|
}
|
|
|
|
export class FeatureControlsPluginExample implements Plugin<void, void, SetupDeps, StartDeps> {
|
|
public setup(coreSetup: CoreSetup<StartDeps>, deps: SetupDeps) {
|
|
coreSetup.application.register({
|
|
id: 'featureControlsExamples',
|
|
title: 'FeatureControlExamples',
|
|
async mount({ element }: AppMountParameters) {
|
|
const [coreStart] = await coreSetup.getStartServices();
|
|
ReactDOM.render(
|
|
<KibanaPageTemplate>
|
|
<KibanaContextProvider services={{ ...coreStart, ...deps }}>
|
|
<MyPluginComponent />
|
|
</KibanaContextProvider>
|
|
</KibanaPageTemplate>,
|
|
element
|
|
);
|
|
return () => ReactDOM.unmountComponentAtNode(element);
|
|
},
|
|
});
|
|
deps.developerExamples.register({
|
|
appId: 'featureControlsExamples',
|
|
title: 'Feature Control Examples',
|
|
description: 'Demo of how to implement Feature Controls',
|
|
});
|
|
}
|
|
|
|
public start(core: CoreStart, deps: StartDeps) {
|
|
return {};
|
|
}
|
|
|
|
public stop() {}
|
|
}
|
|
export const plugin = () => new FeatureControlsPluginExample();
|