Commite728e14

committed

Update the example, and readme

1 parent24dbd83 commite728e14Copy full SHA for e728e14

File tree

+23

-11

lines changed

+23

-11

lines changed

Lines changed: 5 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		-#`@rehooks/DocumentTitle`
	`1`	+#`@rehooks/document-title`
`2`	`2`
`3`		`->React hook forDocumentTitle`
	`3`	`+>React hook forupdating the document-title`
`4`	`4`
`5`	`5`	`>Note: This is using the new[React Hooks API Proposal](https://reactjs.org/docs/hooks-intro.html)`
`6`	`6`	`>which is subject to change until React 16.7 final.`
`@@ -10,17 +10,16 @@`
`10`	`10`	`##Install`
`11`	`11`
`12`	`12`	```sh
`13`		`-yarn add @rehooks/DocumentTitle`
	`13`	`+yarn add @rehooks/document-title`
`14`	`14`	```
`15`	`15`
`16`	`16`	`##Usage`
`17`	`17`
`18`	`18`	```js
`19`		`-importuseDocumentTitlefrom'@rehooks/DocumentTitle';`
	`19`	`+importuseDocumentTitlefrom'@rehooks/document-title';`
`20`	`20`
`21`	`21`	`functionMyComponent() {`
`22`		`-let value=useDocumentTitle();`
`23`		`-// value == DocumentTitle`
	`22`	`+useDocumentTitle('Page Title');`
`24`	`23`	`return<div/>;`
`25`	`24`	`}`
`26`	`25`	```

Lines changed: 12 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,19 @@`
`1`		`-importReactfrom"react";`
	`1`	`+importReact,{useState}from"react";`
`2`	`2`	`import{render}from"react-dom";`
`3`	`3`	`importuseDocumentTitlefrom"./";`
`4`	`4`
`5`	`5`	`functionApp(){`
`6`		`-useDocumentTitle("page Title");`
`7`		`-return<div/>;`
	`6`	`+return<NestedComponent/>;`
	`7`	`+}`
	`8`	`+`
	`9`	`+functionNestedComponent(){`
	`10`	`+const[value,setValue]=useState("page title");`
	`11`	`+useDocumentTitle(value);`
	`12`	`+return(`
	`13`	`+<div>`
	`14`	`+<inputvalue={value}onChange={e=>setValue(e.target.value)}/>`
	`15`	`+</div>`
	`16`	`+);`
`8`	`17`	`}`
`9`	`18`
`10`	`19`	`render(<App/>,window.root);`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`		`-exportdefaultfunctionuseDocumentTitle(title:string);`
	`1`	`+interfaceDocumentTitle{}`
	`2`	`+`
	`3`	`+exportdefaultfunctionuseDocumentTitle(title:string):DocumentTitle;`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`		`-export default function useDocumentTitle(title: string);`
	`1`	`+interface DocumentTitle {}`
	`2`	`+`
	`3`	`+export default function useDocumentTitle(title: string): DocumentTitle;`

Comments

(0)