Sigi framework document
IntroductionFeaturesPackagesRequired polyfill in legacy browsersResources
Basic
Recipes
FAQ
基本概念
深入
常见问题

Deploy codecov npm version Slack Status

Introduction

Sigi is a high level Effect Manager with well designed API based on RxJS and Immer.

TypeScript is not required but strongly recommended.

Features

  • 🌊 Stream: thanks to rxjs, use sigi could get ride of complex flow of internal stats.
  • 💡 Type safe: Sigi provides Type Safe APIs which connect the gap between your Component and Side Effect codes in compile time.
  • 📌 Dependencies Injection: Sigi contains a tiny dependency injection implementation. Which allow you easier to compose your Modules and Services. And it is also provide huge benefit when you want to write some tests.
  • 💖 Multi platforms support: Sigi now support React/React Native and Vue 2.x.

Packages

ProjectStatusDescription
@sigi/corebadgeFramework core APIs to encapsulate related effects
@sigi/reactbadgeReact Hooks APIs
@sigi/vuebadgeVueJS integration library
@sigi/react-routerbadgeReact router integration
@sigi/ssrbadgeServer side rendering support for Vue/React
@sigi/devtoolbadgeRedux devtool integration
@sigi/dibadgeDependencies injection library which allow you compose your own class with Sigi Modules
@sigi/testingbadgeTest helper library

Required polyfill in legacy browsers

Bundle these polyfills on demand, Sigi won't import them directly.

Resources