@procore/labs-components-inspector v0.0.1-alpha

Components Inspector Introduction

A context-based component inspector tool to use in conjuction with view permissions to allow for rapid information gathering on the current react environment

Installation

yarn add @procore/labs-components-inspector

Dependencies

@procore/core-react and react are listed as external peer dependencies. The package will not bundle the code, and requires the app client to provide it as a dependency. The external peer dep is to assure React Context is consistent in a client's React tree, the child consumers can reference the correct parent provider. If the package uses latest features or bug fixes and a new minimum version of core-react is required, it should be considered a breaking change as the peer dependency version must be met.

@procore/labs-third-party-scripts is also another dependency required for this tool to work. There must be a parent Environment component above any usage of the Inspector to allow for proper interaction with Launch Darkly.

Usage

import { Inspector } from '@procore/labs-components-inspector';
import { Environment } from '@procore/labs-third-party-scripts';

<Environment  providers={{ companyId, projectId }}>
  <Inspector/>
</Environment>