Skip to content

Commit 3ba024c

Browse files
committed
rename to react-typed-component.
`react-typed-js` is not available.
1 parent 4cc845a commit 3ba024c

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# react-typed
1+
# react-typed-component
22

33
### A react wrapper for [typed.js](https://github.com/mattboldt/typed.js)
44

55
---
66

77
[Installation](#installation)
88

9-
[Examples](http://kxxt.github.io/react-typed-js)
9+
[Examples](http://kxxt.github.io/react-typed-component)
1010

1111
[Documentation](#documentation)
1212

@@ -17,9 +17,9 @@
1717
Install with [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com/)
1818

1919
```sh
20-
yarn add react-typed-js
20+
yarn add react-typed-component
2121
#or
22-
npm i react-typed-js
22+
npm i react-typed-component
2323
```
2424

2525
---
@@ -29,7 +29,7 @@ npm i react-typed-js
2929
```javascript
3030
import React, { Component } from "react";
3131
import { render } from "react-dom";
32-
import Typed from "react-typed-js";
32+
import Typed from "react-typed-component";
3333

3434
class MyComponent extends Component {
3535
render() {
@@ -64,7 +64,7 @@ render(<MyComponent />, document.getElementById("app"));
6464
```javascript
6565
import React, { Component } from "react";
6666
import { render } from "react-dom";
67-
import Typed from "react-typed-js";
67+
import Typed from "react-typed-component";
6868

6969
class MyComponent extends Component {
7070
render() {
@@ -90,11 +90,11 @@ class MyComponent extends Component {
9090
render(<MyComponent />, document.getElementById("app"));
9191
```
9292

93-
for blinking cursor `import 'react-typed-js/dist/animatedCursor.css';`
93+
for blinking cursor `import 'react-typed-component/dist/animatedCursor.css';`
9494

9595
#### Documentation
9696

97-
React-typed-js supports all official options that you can find [here](http://www.mattboldt.com/typed.js/docs/).
97+
`react-typed-component` supports all official options that you can find [here](http://www.mattboldt.com/typed.js/docs/).
9898
But also supports some extra props:
9999

100100
| propType | required | default | description |

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"name": "react-typed-js",
2+
"name": "react-typed-component",
33
"version": "1.0.0",
44
"description": "A react wrapper for typed.js",
55
"main": "dist/react-typed.js",
6-
"types": "./react-typed.d.ts",
6+
"types": "./react-typed-components.d.ts",
77
"scripts": {
88
"build": "webpack",
99
"test": "jest --coverage",
@@ -16,7 +16,7 @@
1616
"license": "MIT",
1717
"repository": {
1818
"type": "git",
19-
"url": "https://github.com/kxxt/react-typed-js.git"
19+
"url": "https://github.com/kxxt/react-typed-component.git"
2020
},
2121
"tags": [
2222
"react",

react-typed.d.ts renamed to react-typed-component.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// <reference types="react" />
22

3-
declare module "react-typed" {
3+
declare module "react-typed-component" {
44
export interface ReactTypedProps {
55
typedRef?: Function;
66
/** initialize in stopped state */

src/stories/ReactTyped.stories.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ const description = `
1616
let typedInstance; // only for demo
1717
const defaults = {
1818
strings: [
19-
"welcome to react-typed-js",
19+
"welcome to react-typed-component",
2020
'This is a react component that wraps up the <a href="https://github.com/mattboldt/typed.js/">typed.js</a>',
21-
'If you like the project add a star in <a href="https://github.com/mattboldt/typed.js/">typed.js</a> and <a href="https://github.com/kxxt/react-typed-js">react-typed-js</a>',
21+
'If you like the project add a star in <a href="https://github.com/mattboldt/typed.js/">typed.js</a> and <a href="https://github.com/kxxt/react-typed-component">react-typed-component</a>',
2222
],
2323
typeSpeed: 50,
2424
backSpeed: 20,

webpack.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const CopyPlugin = require("copy-webpack-plugin");
55
module.exports = {
66
mode: "production",
77
entry: {
8-
"react-typed": "./src/index.js",
8+
"react-typed-component": "./src/index.js",
99
},
1010
externals: {
1111
react: {
@@ -28,7 +28,7 @@ module.exports = {
2828
path: path.resolve(__dirname, "dist"),
2929
publicPath: "/",
3030
libraryTarget: "umd",
31-
library: "react-typed",
31+
library: "react-typed-component",
3232
globalObject: "this",
3333
},
3434

0 commit comments

Comments
 (0)