react-event-cards

0.1.7 • Public • Published

React Event Cards

This is a simple component that let's you dynamically fetch events from any public google calendar and display each event as it's own pre-styled event card containing the information from that event. At the bottom of each card is a Google Map (if the event has a location), which will animate to reveal the full map if hovered over or tapped on (mobile supported).

Prerequisites

In order to get started and use React-Event-Cards; you will need a few things:

  • A Public Google Calendar & It's ID
  • API key/s for Google Maps and Google Calendar

Getting started

To get React-Event-Cards working in your projects, follow these easy steps:

  1. Install the component with npm i --save react-event-cards
  2. Add script tag to html <script src="https://maps.googleapis.com/maps/api/js?key=[YOUR KEY HERE]" type="text/javascript"></script>

To call the component in it's default state (without additional paramaters);

 <CalendarCards
        calID="YOUR CALENDAR ID HERE"
        gAPI="YOUR GOOGLE API KEY HERE"
        cards="1" />

dxcaxbeiqv

Please note that you need to specify how many cards you want to display or none will show.

Component Options

Currently, the CalenderCards component can only take 2 additional arguments, one for the background color and another for the text color.

One can alter the background color with bColor and the text color with tColor.

 <CalendarCards
        calID="YOUR CALENDAR ID HERE"
        gAPI="YOUR GOOGLE API KEY HERE"
        bColor="#d6cc66"
        tColor="black"
        cards="1" />

dxcaxbeiqv

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Readme

Keywords

none

Package Sidebar

Install

npm i react-event-cards

Weekly Downloads

0

Version

0.1.7

License

MIT

Unpacked Size

22.8 kB

Total Files

9

Last publish

Collaborators

  • eladkarni