https://github.com/KATT/use-is-typing

… React Hook for typing indicator
https://github.com/KATT/use-is-typing

Last synced: about 2 months ago
JSON representation

… React Hook for typing indicator

• Host: GitHub
• URL: https://github.com/KATT/use-is-typing
• Owner: KATT
• License: mit
• Archived: true
• Created: 2020-04-03T14:03:27.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-22T01:10:31.000Z (almost 4 years ago)
• Last Synced: 2024-04-18T13:32:06.811Z (8 months ago)
• Language: TypeScript
• Homepage: https://codesandbox.io/s/use-is-typing-jz5i6
• Size: 365 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-react-hooks - `useIsTyping`
• awesome-react-hooks-cn - `useIsTyping`
• awesome-react-hooks - `useIsTyping`
• awesome-react-hooks - `useIsTyping`

README

        
# `use-is-typing` 

See if someone is typing into an input or textarea.

## Install

```sh

yarn add use-is-typing

```

```

npm i use-is-typing --save

```

## Example

- See more examples [`./storybook`](./stories/useIsTyping.stories.tsx)

- [Try it at CodeSandbox](https://codesandbox.io/s/use-is-typing-jz5i6)

### Basic

```tsx

import * as React from 'react';

import * as ReactDOM from 'react-dom';

import { useIsTyping } from 'use-is-typing';

const App = () => {

  const [isTyping, register] = useIsTyping();

  return (

    


      

      


      Typing? {isTyping ? '✅' : '❌'}

    

  );

};


ReactDOM.render(, document.getElementById('root'));

```

### With [Material UI](https://material-ui.com/)

```tsx

export const MaterialUITextField = () => {

  const [isTyping, register] = useIsTyping();

  return (

    


      

      

      

        Typing? {isTyping ? '✅' : '❌'}

      

    

  )

};

```


### Customize timeout

By default, the typing indicator is set to `false` after 1000ms, this can be changed:

```tsx

const [isTyping, register] = useIsTyping({ timeout: 300 }); // timeout after 300ms

```

## Contributing

This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx). See sections below for info on how to get it running.

### Configuration

Code quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.

### Commands

TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.

The recommended workflow is to run TSDX in one terminal:

```

npm start # or yarn start

```

This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.

Then run either example playground or storybook:

#### Storybook

Run inside another terminal:

```

yarn storybook

```

This loads the stories from `./stories`.

> NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.

#### Jest

Jest tests are set up to run with `npm test` or `yarn test`. This runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.