1.0.2 ā€¢ Published 5 years ago

control-flux v1.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

control-flux

Travis npm package Coveralls MIT license

šŸŽˆ control-flux provide components that mimic some methods of javascript, for a pure declarative approach, or something like that.

Installation

Use the package manager npm to install control-flux.

npm i control-flux

šŸ‘“ Some example

You can filter by property for display the right user

import { FilterBy } from "control-flux"

export const User = () => {
  return (
    <FilterBy
      on={[
        { username: "Francis", type: "admin" },
        { username: "John", type: "guest" },
        { username: "Kit", type: "guest" }
      ]}
      property="username"
      predicate={username => username === "Francis"}
    >
      {user => <User {...user} /> }
    </FilterBy>
  )
}

or display n times a component

import { Times } from "control-flux"

export const Times = () => {
  return (
    <Times n={3}>
      <BedsIcon />
    </Times>
  )
}

or filter and join

import { Filter, Join } from "control-flux"

export const Useless = () => {
  return (
    <Filter
      on={["really", "wtf", "amazing"]}
      predicate={v => v !== "wtf"}
    >
      {wordsFiltered => (
        <Join
          on={wordsFiltered}
          separator=" āœŒļø "
        >
          {v => v}
        </Join>
      )}
    </Filter>
  )
}

result: really āœŒļø amazing

API

  • Every
  • Filter
  • Map
  • Some
  • Includes
  • Sort
  • Fill
  • Find
  • FindIndex
  • Join
  • Reverse
  • Reduce
  • ReduceRight
  • ObjectKeys
  • ObjectEntries
  • FilterBy
  • First
  • Last
  • Times
  • If

šŸš¶ Developed By

Francesco Megna

šŸ‘ How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

šŸ‘· Roadmap

  • Normalize api based on MDN doc
  • Expand the components taking inspiration from other javascript prototypes.

šŸ“ƒ License

MIT License

Copyright (c) 2019 Francesco Megna

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago