@webiny/app-wcp v5.39.5
@webiny/app-wcp
A set of frontend Webiny Control Panel (WCP)-related utilities.
Table of Contents
Installation
npm install --save @webiny/app-wcp
Or if you prefer yarn:
yarn add @webiny/app-wcp
Overview
The @webiny/app-wcp
package contains essential Webiny Control Panel (WCP)-related utilities, that can be used within a React app. These include the WcpProvider
provider component and the useWcp
hook, which can be used to retrieve the current WCP project information and inspect whether a specific feature is available.
ℹ️ INFO
Internally, the
WcpProvider
provider retrieves WCP project information from the Webiny's default GraphQL API. Because of this, note that this project relies on@webiny/api-wcp
when it comes to retrieving project information (via GraphQL).
Examples
Example | Description |
---|---|
Setup | Shows how to set up the WcpProvider provider React component. |
Reference
Components
WcpProvider
export declare const Wcp: React.FC;
The WcpProvider
is a provider component, which retrieves the WCP project information. The component also makes it possible to use the useWcp
hook, which can be used to get the current WCP project information or inspect whether a specific WCP feature is allowed to be used within the React app.
import React from "react";
import { WcpProvider } from "@webiny/app-wcp";
const App = () => {
return (
<WcpProvider>
<MyApp />
</WcpProvider>
);
};
export const App;
Hooks
useWcp
interface UseWcpHook {
getProject: () => WcpProject | null;
canUseFeature: (featureId: string) => boolean;
}
export declare function useWcp(): UseWcpHook;
The useWcp
hook can be used to get the current WCP project information and inspect whether a specific WCP feature is allowed to be used within the React app.
import React from "react";
import { useWcp } from "@webiny/app-wcp";
export const MyComponent = () => {
const { canUseFeature } = useWcp();
if (canUseFeature("advancedPublishingWorkflow")) {
return <span>We can use Advanced Publishing Workflow (APW).</span>;
}
return <span>We cannot use Advanced Publishing Workflow (APW).</span>;
};
3 days ago
3 days ago
3 days ago
9 days ago
15 days ago
16 days ago
30 days ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
8 months ago
8 months ago
5 months ago
5 months ago
6 months ago
9 months ago
9 months ago
9 months ago
8 months ago
9 months ago
6 months ago
7 months ago
8 months ago
8 months ago
6 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
10 months ago
6 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
9 months ago
5 months ago
9 months ago
9 months ago
9 months ago
6 months ago
6 months ago
7 months ago
6 months ago
8 months ago
7 months ago
9 months ago
8 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
7 months ago
5 months ago
5 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago