https://github.com/evelynhathaway/context-thief

⚛🦹‍♀️ Helper function to steal React context values for testing
https://github.com/evelynhathaway/context-thief

context enzyme nodejs react testing testing-library

Last synced: 28 days ago
JSON representation

⚛🦹‍♀️ Helper function to steal React context values for testing

• Host: GitHub
• URL: https://github.com/evelynhathaway/context-thief
• Owner: evelynhathaway
• License: mit
• Created: 2020-12-05T22:44:23.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T19:23:56.000Z (over 2 years ago)
• Last Synced: 2025-01-20T03:32:09.717Z (about 1 month ago)
• Topics: context, enzyme, nodejs, react, testing, testing-library
• Language: TypeScript
• Homepage: https://npmjs.com/package/context-thief
• Size: 1.28 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        




# Context Thief

**Helper function to steal React context values for testing**

[![npm version](https://badgen.net/npm/v/context-thief?icon=npm)](https://www.npmjs.com/package/context-thief)

[![check status](https://badgen.net/github/checks/evelynhathaway/context-thief/main?icon=github)](https://github.com/evelynhathaway/context-thief/actions)

[![license: MIT](https://badgen.net/badge/license/MIT/blue)](/LICENSE)



## Description

Context Thief stores the current context value for the inputted context for use in tests.

If you test components with contexts and don't want to create a new function or component every time, this module is for you!

## Installation

```bash

npm install --save-dev context-thief

```

## Usage

### `createContextThief(context)`

**Returns**: `{ContextThief, contextValue}` Object containing the component to render and the outputted value

| Parameter | Type      | Description                            |

| --------- | --------- | -------------------------------------- |

| context   | `Context` | Instance of `React.Context` to consume |

## Example

**`example-component.tsx`**

```tsx

import React from "react";

export const ExampleContext = React.createContext(false);

export const ExampleComponent: React.FC<{children: React.ReactNode}> = ({children}) => {

    return (

        

            {children}

        

    );

};

```

**`example-component.test.tsx`**

```tsx

import React from "react";

import {render} from "@testing-library/react";

import {createContextThief} from "context-thief";

import {ExampleContext, ExampleComponent} from "./example-component";

it("should have the default current context value", () => {

    const {ContextThief, contextValue} = createContextThief(ExampleContext);

    render(

        

            

        

    );

    expect(contextValue.current).toBe(true);

});

```

## License

Copyright Evelyn Hathaway, [MIT License](/LICENSE)

### Icon Glyph

Icon glyph made by [Gregor Cresnar](https://thenounproject.com/grega.cresnar/)