This package has been deprecated

Author message:

@misk/components has been renamed to @misk/core. Use @misk/core moving forward.

@misk/components
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

Misk Components

This package provides shared, styled React components across Misk tab repos. The top of each component/container file contains a usage example.

Getting Started

$ yarn add @misk/components

Builders

  • createApp(routes): builder function to create an <App history={history}/> component
  • createIndex(tabSlug, App, Ducks): builder function to create bootstrapping objects necessary for index.tsx

Components

  • ErrorCalloutComponent: Processes a Redux / Axios error and dumps raw JSON for debugging
  • OfflineComponent: NonIdealState component for Offline or Loading tab state
  • PathDebugComponent: outputs values passed in by props for hash, pathname, and search in React-Router instance
  • SidebarComponent: dashboard styled sidebar

Containers

  • DesktopWideOnlyContainer: Only shows container when window width >1200px
  • FlexContainer: Container using CSS FlexBox to have enclosed items flow responsively to screen width
  • MobileNeverContainer: Never show container when window width <768px
  • MobileOnlyContainer: Only show container when window width <768px
  • ResponsiveContainer: Responsive container that all tabs and Nav Navbar use to ensure consistent view width

Ducks

  • routerDucks: router management Redux-Sagas parts (actions, dispatcher, handlers, sagas, reducers, state interface)
  • simpleNetworkDucks: a standardized set of Axios based request Redux-Sagas parts (actions, dispatcher, handlers, sagas, reducers, state interface)

Features

  • Navbar: Related components to a dashboard styled Navbar

Utilities

  • environment: various utilities helpful in environment (color, default visibilities...)
  • network: wrapped functions around Axios requests to allow simplified syntax that with async await returns an object of { data, error }.

Releasing

Changelog (and Breaking Changes)

Readme

Keywords

none

Package Sidebar

Install

npm i @misk/components

Weekly Downloads

41

Version

0.1.0

License

SEE LICENSE IN https://github.com/square/misk-web

Unpacked Size

1.14 MB

Total Files

37

Last publish

Collaborators

  • k9101
  • rmariano-sq
  • square-owner
  • adrw
  • adrw-ci