flux README

The project's README from github.com/facebookarchive/flux. As one markdown file: README.md.

⚠️ The Flux project has been archived and no further changes will be made. We recommend using more sophisticated alternatives like Redux, MobX, Recoil, Zustand, or Jotai.

logo

Flux

An application architecture for React utilizing a unidirectional data flow.
Licence Badge Current npm package version.

Getting Started

Start by looking through the guides and examples on Github. For more resources and API docs check out facebook.github.io/flux.

How Flux works

For more information on how Flux works check out the Flux Concepts guide, or the In Depth Overview.

Requirements

Flux is more of a pattern than a framework, and does not have any hard dependencies. However, we often use EventEmitter as a basis for Stores and React for our Views. The one piece of Flux not readily available elsewhere is the Dispatcher. This module, along with some other utilities, is available here to complete your Flux toolbox.

Installing Flux

Flux is available as a npm module, so you can add it to your package.json file or run npm install flux. The dispatcher will be available as Flux.Dispatcher and can be required like this:

const Dispatcher = require('flux').Dispatcher;

Take a look at the dispatcher API and some examples.

Flux Utils

We have also provided some basic utility classes to help get you started with Flux. These base classes are a solid foundation for a simple Flux application, but they are not a feature-complete framework that will handle all use cases. There are many other great Flux frameworks out there if these utilities do not fulfill your needs.

import {ReduceStore} from 'flux/utils';

class CounterStore extends ReduceStore<number> {
  getInitialState(): number {
    return 0;
  }

  reduce(state: number, action: Object): number {
    switch (action.type) {
      case 'increment':
        return state + 1;

      case 'square':
        return state * state;

      default:
        return state;
    }
  }
}

Check out the examples and documentation for more information.

Building Flux from a Cloned Repo

Clone the repo and navigate into the resulting flux directory. Then run npm install.

This will run Gulp-based build tasks automatically and produce the file Flux.js, which you can then require as a module.

You could then require the Dispatcher like so:

const Dispatcher = require('path/to/this/directory/Flux').Dispatcher;

The build process also produces de-sugared versions of the Dispatcher and invariant modules in a lib directory, and you can require those modules directly, copying them into whatever directory is most convenient for you. The flux-todomvc and flux-chat example applications both do this.

License

Flux is BSD-licensed. We also provide an additional patent grant.

flux (facebookarchive/flux)

Searching Database…

17.4K ·GitHub
Flux
archived
Что это такое?Flux — это архитектура приложения для построения пользовательских интерфейсов на React, в основе которой лежит однонаправленный поток данных.
Flux — это фреймворк или библиотека?Строго говоря, ни то ни другое — в README сказано, что это скорее паттерн, а не фреймворк, и жёстких зависимостей у него нет. Пакет в npm в основном добавляет Dispatcher и несколько вспомогательных классов.
Как добавить его в свой проект?Выполните npm install flux или добавьте его в package.json — после этого диспетчер станет доступен как Flux.Dispatcher. Документация и описание API находятся на facebook.github.io/flux.
Нужно ли что-то ещё, например React?Ничего обязательного нет — Flux это паттерн. На практике его обычно используют вместе со сторами на EventEmitter и вью на React, а сам пакет зависит от fbjs и fbemitter.
Flux ещё активно развивается?Нет — проект заархивирован, и изменений больше не будет. Установить его по-прежнему можно, но команда рекомендует более современные альтернативы.
Можно ли использовать Flux в коммерческих проектах?Да — Flux распространяется по лицензии BSD, и Facebook дополнительно даёт патентную лицензию поверх неё.
Что такое Dispatcher и почему он идёт именно из этого пакета?Это единственная часть Flux, которую сложно найти где-то ещё, поэтому npm-пакет поставляет её как Flux.Dispatcher вместе с остальными утилитами, чтобы у вас был полный набор инструментов для Flux.
Что за классы Flux Utils?Это базовые классы, которые дают простому Flux-приложению надёжную отправную точку. Они намеренно не являются фреймворком со всеми возможностями — если нужно больше, README отсылает к другим Flux-фреймворкам и примерам.
Есть ли примеры приложений, на которых можно учиться?Да — в репозитории есть flux-todomvc и flux-chat, а на странице GitHub приведены ссылки на дополнительные руководства и примеры. Гайд Flux Concepts и In Depth Overview объясняют, как всё это устроено.
Что выбрать для нового проекта вместо Flux?В уведомлении об архивации в качестве более развитых альтернатив названы Redux, MobX, Recoil, Zustand и Jotai — для всего нового это более надёжный выбор, так как Flux меняться не будет.
What are similar projects?Recoil, redux-form, nuqs, material, immer, hyperapp, normalizr, velocity
Which topics is it in?design-patterns, state-management, architecture, javascript-library, bsd, deprecated, ui, web-development, react, free, npm, frontend
Creator
facebookarchive
Size
5.4 MB
Stars
17.4K
Updated
CommitMar 21Release4.0.3Dec 10
Age
12y
Commits · 90 Days