react-smart-card

    0.4.0 • Public • Published

    react-smart-card

    React Smart Card Component is a multi purpose / multi variant card component with features shown below. Add any color to card contents! No limitation.
    Component can be adapted to any layout by simply wrapping it in the grid or columns markup.

    Installation

    npm install react-smart-card --save
    

    Usage

     
    import SmartCard from 'react-smart-card';
     
    function App() {
        //data can be stored in a variable
        const headingText = "heading";
     
        //data can be stored in a object
        const myObj = {
          heading: 'heading',
          des: 'description',
          linkText: 'Read More',
          linkUrl: 'https://www.npmjs.com/package/react-smart-card'
        };
        //data can be simply passed as string as well
        return (
          <>
            <div className="flex container">
              <div className="col-md-4 pad-responsive">
                <SmartCard title={headingText} des="Text color can be customized" />
              </div>
              <div className="col-md-4 pad-responsive">
                <SmartCard title={myObj.heading} des={myObj.des} linkText={myObj.linkText} linkUrl={myObj.linkUrl}/>
              </div>
            </div>
          </>
        );
    }
     
    export default App;

    UI Variations

    <div className="flex container">
      <div className="col-md-4 pad">
        <SmartCard title="Header" des="Description" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard title="Header" des="Description" linkUrl="/path" linkText="Read More" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard title="Header" des="Description" btnUrl="/path" btnText="Know More" />
      </div>
    </div>
    <div className="flex container">
      <div className="col-md-4 pad">
        <SmartCard imgSrc="/image-path" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard imgSrc="/image-path" title="Header" des="Description" btnUrl="/path" btnText="Know More"
                   titleColor="orange" desColor="red" btnBg="orange" btnColor="white"/>
      </div>
    </div>
    How does it look?

    Alt text
    Alt text

    Image Overlay Card

    To enable image overlay card component pass the prop cardType="rsc-overlay"

    <div className="flex container">
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-overlay" imgSrc="/path" title="Header" des="Description" subText="Last updated 2 mins ago" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-overlay" imgSrc="/path" title="Header" des="Description" subText="Last updated 2 mins ago" linkUrl="/path" linkText="Read More" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-overlay" imgSrc="/path" title="Header" des="Description" subText="Last updated 2 mins ago" btnUrl="/path" btnText="Know More" />
      </div>
    </div>

    Alt text

    Image Horizontal Card

    To enable image horizontally to right or left in the card component pass the prop cardType either "rsc-image-left" or "rsc-image-right"

    <div className="flex container">
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-image-left" imgSrc="/path" title="Header" des="Description" authorImg="/path" authorName="Ravi Teja Kolla" subText="Feb 29, 2020" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-image-right" imgSrc="/path" title="Header" des="Description" btnUrl="/path" btnText="Read More" />
      </div>
      <div className="col-md-4 pad">
        <SmartCard cardType="rsc-image-right" imgSrc="/path" title="Header" des="Description" linkUrl="/path" linkText="Know More" />
      </div>
    </div>

    Alt text Alt text

    Style Guide

    Default Colors

    Title : Black
    Description : Black
    Link : Blue
    Button Text : White
    Button Background : Blue

    Link Text Themes

    Alt text
    Link theme is selected by passing value to linkTheme prop
    Example

    linkTheme='rsc-link-green'
    
    Button Themes

    Alt text
    Button theme is selected by passing value to btnTheme prop
    Example

    btnTheme='rsc-btn-green'
    
    Custom Colors

    You can choose custom colors by passing color CSS values as props.
    Examples

    titleColor="#000", desColor="black", linkColor="rgba(180, 44, 1, 1)", btnBg="orange", btnColor="white"
    

    Release Notes

    v0.4.0 Horizontal Image variant added
    v0.3.0 Image Overlay Variant added
    v0.2.0 Image card & Card component with Image & text added
    v0.1.0 Text card component added

    Contact Us

    License

    MIT License

    Copyright (c) 2020 Ravi Teja Kolla

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i react-smart-card

    DownloadsWeekly Downloads

    10

    Version

    0.4.0

    License

    MIT

    Unpacked Size

    21.1 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar