Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-klein authored Jan 11, 2019
1 parent 650beaa commit 7f2b37a
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
# functional-components (uninspired name subject to change)
<h1 align="center">
funcy.js: A functional web-components wrapper
</h1>
<p align="center">
<img src="https://i.imgur.com/1nJ9kJd.png" width="572" alt="example of code">
</p>

### Why 'funcy.js'?

Naming things is hard and 'funcy.js' seemed like a [fun](http://www.badum-tish.com/), recognizable name.

### What is it?

funcy.js seeks to provide a functional way of defining web components, very much akin to [react](https://reactjs.org/) [functional components](https://reactjs.org/docs/components-and-props.html#function-and-class-components) with [hooks](https://reactjs.org/docs/hooks-intro.html). This is as of right now *purely experimental*.

Proper documentation will follow soon. For now you may look at todo example in the examples folder or the following codepen:

This library wraps web components in a functional api with hooks (think React functional components).
This is as of right now purely experimental.

Proper documentation will follow. For now you may look at the __examples folder__ and this:

https://michael-klein.github.io/functional-components/examples/todo.html

## currently implemented hooks:
#### currently implemented hooks:

* __useReducer__
* __useState__
* __useEffect__
* useRenderer
* usePreactHtm
* useAttribute
* useCSS
* useExposeMethod

0 comments on commit 7f2b37a

Please sign in to comment.