Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.16 KB

README.md

File metadata and controls

40 lines (29 loc) · 2.16 KB
Raw

Contexts

This UI makes use of React Context for top level state management. This allows for data to be stored and accessed by any component without needing to prop drill values to that component. In addition, depending on use case, contexts can be used as a component or as a React Hook, allowing for integration of state where ever and however it is required. This directory contains all the custom React Context implementations used across this UI.

It is expected that when used in production Context Provider(s) will be used by the code contained in the Bootstrap directory. Consumers of the state could be either other Bootstrap components, or Panel or Group components.

Test approach

Elements should be tested in a functional manor. See Test Driven Development.

Expected files

For a given new Context FeatureFlagContext, the expected files are as follows:

Contexts/
  index.ts
  types.ts
  FeatureFlagContext/
    README.md
    FeatureFlagContext.ts
    FeatureFlagContext.assets.ts
    FeatureFlagContext.spec.ts
    FeatureFlagContext.types.ts

Where:

  • index.ts acts as a barrel file, exporting all public elements of this context/the contexts contained in the Context directory
  • types.ts acts as a barrel file, exporting all the public types of each context
  • README.md is the readme for this Context, detailing design choices and usage
  • FeatureFlagContext.ts is the implementation of this context
  • FeatureFlagContext.spec.ts are the tests for this context
  • FeatureFlagContext.assets.ts are the test assets for this context
  • FeatureFlagContext.types.ts are the types for this context

Available contexts

  • Introspect - responsible for fetching, parsing and providing the UI with the supported capabilities of the backend GraphQL server
  • ConfigFeatureFlag - responsible for fetching and providing the current configuration and feature flag state, retrieved from the UI Server config module