Skip to content

Commit

Permalink
Rename package to @mediamonks/react-kit #257
Browse files Browse the repository at this point in the history
  • Loading branch information
leroykorterink committed Nov 3, 2023
1 parent 49c9102 commit aff6dda
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
[![npm version](https://img.shields.io/npm/v/@mediamonks/react-hooks)](https://www.npmjs.com/package/@mediamonks/react-hooks)
[![npm downloads](https://img.shields.io/npm/dm/@mediamonks/react-hooks)](https://www.npmjs.com/package/@mediamonks/react-hooks)
[![npm version](https://img.shields.io/npm/v/@mediamonks/react-kit)](https://www.npmjs.com/package/@mediamonks/react-kit)
[![npm downloads](https://img.shields.io/npm/dm/@mediamonks/react-kit)](https://www.npmjs.com/package/@mediamonks/react-kit)

# @mediamonks/react-hooks
# @mediamonks/react-kit

Collection of commonly used React hooks.

## Getting started

### Installing

Add `@mediamonks/react-hooks` to your project:
Add `@mediamonks/react-kit` to your project:

```sh
npm i @mediamonks/react-hooks
npm i @mediamonks/react-kit
```

### Example

Use a hook inside a component:

```tsx
import { useToggle } from '@mediamonks/react-hooks';
import { useToggle } from '@mediamonks/react-kit';

function DemoComponent() {
const [state, toggle] = useToggle(false);
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@mediamonks/react-hooks",
"name": "@mediamonks/react-kit",
"version": "1.4.0",
"description": "A collection of React hooks we use at Media.Monks",
"keywords": [
Expand Down
4 changes: 2 additions & 2 deletions src/hooks/useMediaQuery/useMediaQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import { useEventListener } from '../useEventListener/useEventListener.js';
* describe media queries in your project.
*
* @example
* import '@mediamonks/react-hooks';
* import '@mediamonks/react-kit';
*
* declare module '@mediamonks/react-hooks' {
* declare module '@mediamonks/react-kit' {
* interface MediaQueryVariables {
* '--media-query-name': never;
* }
Expand Down

0 comments on commit aff6dda

Please sign in to comment.