Git Product home page Git Product logo

react-calendar's Introduction

A cross-platform React calendar component

Features

  • Flexbox layout
  • Inline styles using styled-components ๐Ÿ’…
  • Theming support
  • Localisation support
  • Storybook browsing
  • Monorepo project structure
  • React Native component (coming soon)

Getting Started

This project is organised into multi-package repositories, a.k.a monorepo.

Lerna is the tool used to create and manage this monorepo.

  1. First, clone the repo, then install all the package dependencies and link any cross-dependencies using the lerna bootsrap command:
git clone https://github.com/johnwakley/react-calendar
cd react-calendar
yarn install
yarn bootstrap
  1. Preview the calendar component using Storybook
cd packages/react-calendar
yarn storybook

Tests

Run lint, flow, unit and snapshot tests across all packages (execute from root package level)

yarn test

Theming

Theming support is provided by styled-components ThemeProvider wrapper

Use the default theme structure defined in /packages/react-calendar/src/themes/ical.js as the basis for custom styles.

i18n

Supported locales are listed here: https://github.com/moment/moment/tree/develop/locale

To display the calendar for a specific locale, pass the locale value to the locale prop of either the CalendarYear or CalendarMonth component.

react-calendar's People

Contributors

johnwakley avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.