Code Monkey home page Code Monkey logo

basic-react-ui-footer's Introduction

Basic React UI - Footer


Part of a series of reusable React Components, to be available as npm packages! Basic React UI - Footer. Simply enter values in as props, and the rest is taken care of for you!
Explore the docs »

View Demo --> · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

[Product Name Screen Shot

Props You Can Specify

PROP PROP-TYPE DESCRIPTION
title String Required. Ideally business name/your name.
logo String Optional. Include image URL to your logo. Goes above title.
subtitle String Optional. Brief description about yourself/business.
phonenumber String Optional.
email String Optional.
primaryFontColor String Optional. Default is off-white
secondaryFontColor String Optional. Default is slightly darker off-white.
copyright String Required. Your name/business name.
copyrightColor String Optional. Default is a light grey.
backgroundColor String Optional. Default is mid-dark grey.
facebook String Optional. Link your Facebook profile!
github String Optional. Link your Github profile!
linkedin String Optional. Link your LinkedIn profile!
twitter String Optional. Link your Twitter profile.
angellist String Optional. Link your AngelList profile.
youtube String Optional. Link your Youtube profile.
iconSize String Optional. Default is 1.5rem.
iconColor String Optional. Default is off-white. *if you specify this, note that on hover effects won't work!

Secondary Navigation Object (Optional)

Create a "pages" object in the component you are using , like this, for example:

const pages = [
      {
        title: 'Company',
        pageList: [
          {
            name: 'About',
            link: '/about',
          },
          {
            name: 'Locations',
            link: '/careers',
          },

          {
            name: 'Careers',
            link: '/careers',
          },
        ],
      },
      {
        title: 'Legal',
        pageList: [
          {
            name: 'Privacy',
            link: '/privacy',
          },
          {
            name: 'Terms',
            link: '/terms',
          },
        ],
      },
      {
        title: 'Help Center',
        pageList: [
          {
            name: 'FAQ',
            link: '/faq',
          },
          {
            name: 'Return Policy',
            link: '/returnpolicy',
          },
        ],
      },
    ];
PROP PROP-TYPE DESCRIPTION
title String Required. A nav heading for each list of pages.
pageList Array Required. An array of objects with name and link for each page you'd like in your secondary nav.
pageList.name String Required. Name of page.
pageList.link String Required. Link to page.

Built With

Getting Started

To run the project:

  1. Clone the repo
    git clone https://github.com/bmumz/basic-react-ui-footer
  2. Install NPM packages
    npm install
  3. Run npm start
    npm start

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - Portfolio - LinkedIn @brandiCodes on Twitter - [email protected]

Acknowledgements

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.