Skip to content

Latest commit

 

History

History
327 lines (200 loc) · 5.14 KB

DOCUMENTATION.md

File metadata and controls

327 lines (200 loc) · 5.14 KB

Components

src/components/Index.js

1. Index

Main page content

<Index />

src/components/auth/LoginUser.js

1. LoginUser

Form for user login

<LoginUser />

src/components/auth/LogoutUser.js

1. LogoutUser

Logout user

<LogoutUser />

src/components/auth/ProfileUser.js

1. ProfileUser

User profile page with password reset button

<ProfileUser />

src/components/auth/RegisterUser.js

1. RegisterUser

Form for user registration

<RegisterUser />

src/components/businesses/BusinessButtons.js

1. BusinessButtons

Generate View and Review buttons for non-business owners

@param {object} props.business Component props containing Business

<BusinessButtons business="{business}" />

src/components/businesses/BusinessCards.js

1. BusinessCards

Generate a list of business cards

@param {object} props.user Contains user data @param {object} props.businesses_list Contains list of businesses

<BusinessCards user="{user}" businesses_list="{businesses_list}" />

src/components/businesses/BusinessModals.js

1. BusinessModals

Generate View, Review, Edit and Delete modals for businesses

@param {object} props.businesses Contains business list @param {function} props.showUpdatedBusinesses Business list update function

<BusinessModals
  businesses="{businesses}"
  showUpdatedBusinesses="{showUpdatedBusinesses}"
/>

src/components/businesses/BusinessOwnerButtons.js

1. BusinessOwnerButtons

Generate View, Edit and Delete buttons for business owners

@param {object} props.business Component props containing Business

<BusinessOwnerButtons business="{business}" />

src/components/businesses/BusinessSearch.js

1. BusinessSearch

Form for business search

@param {function} props.searchBusinesses Form submit callback function searchBusinesses

<BusinessSearch searchBusinesses="{searchBusinesses}" />

src/components/businesses/BusinessesList.js

1. BusinessesList

List all businesses in a searchable, paginated display

<BusinessesList />

src/components/businesses/DeleteBusiness.js

1. DeleteBusiness

Form for deleting a business

@param {object} props.business Business object @param {function} props.showUpdatedBusinesses Form callback function

<DeleteBusiness
  business="{business}"
  showUpdatedBusinesses="{showUpdatedBusinesses}"
/>

src/components/businesses/RegisterBusiness.js

1. RegisterBusiness

Form for registering a business

@param {function} props.showUpdatedBusinesses Form callback function showUpdatedBusinesses

<RegisterBusiness showUpdatedBusinesses="{showUpdatedBusinesses}" />

src/components/businesses/ReviewBusiness.js

1. ReviewBusiness

Form for reviewing a business

@param {object} props.business Business object @param {function} props.showUpdatedBusinesses Form callback function

<ReviewBusiness
  business="{business}"
  showUpdatedBusinesses="{showUpdatedBusinesses}"
/>

src/components/businesses/ReviewCards.js

1. ReviewCards

Generate a list of review cards for a business

@param {object} props.reviews_list Contains list of business reviews

<ReviewCards reviews_list="{reviews_list}" />

src/components/businesses/ShowBusiness.js

1. ShowBusiness

Display a business' information and reviews

@param {object} props.business Component props containing Business

<ShowBusiness business="{business}" />

src/components/businesses/UpdateBusiness.js

1. UpdateBusiness

Form for updating a business

@param {object} props.business Business object @param {function} props.showUpdatedBusinesses Form callback function

<UpdateBusiness
  business="{business}"
  showUpdatedBusinesses="{showUpdatedBusinesses}"
/>

src/components/shared/Footer.js

1. Footer

Footer

<footer />

src/components/shared/Header.js

1. Header

Header

<header />

src/components/shared/Layout.js

1. Layout

The Layout for the entire application. All content is placed between the Header and Footer

<Layout />

src/components/shared/Paginator.js

1. Paginator

Generate Prev and Next buttons for a paginated list @param {object} props Component props @param {integer} props.prev_page Id for the previous page @param {integer} props.next_page Id for the next page @param {function} props.handlePageChange Paginator callback function

<Paginator
  prev_page="{1}"
  next_page="{2}"
  handlePageChange="{this.handlePageChange}"
/>

src/components/shared/UserTabs.js

1. UserTabs

Navigation menu options for a logged in user

<UserTabs />

src/components/shared/VisitorTabs.js

1. VisitorTabs

Navigation menu options for a visitor to the site

<VisitorTabs />

This document was generated by the React DOC Generator v1.2.5.