@fatherly-funnies/joke-card
Version:
React component to display a daily joke
33 lines (17 loc) • 1.38 kB
Markdown
<h1>About</h1>
<p>JokeCard is a React component that will display a different joke every business day</p>
<h2>Installation</h2>
<code>npm install --save @fatherly-funnies/joke-card</code>
<h2>Utilization</h2>
<h3>JokeCard Component</h3>
<code>import { JokeCard } from '@fatherly-funnies/joke-card';</code>
<h2>Props</h2>
<code>backgroundColor</code> : <span>(String, optional, default='#cccccc') Set the background color for the Paper containing the joke</span>
<code>borderRadius</code> : <span>(String, optional, default='10px') Sets the border radius on the joke container</span>
<code>color</code> : <span>(String, optional, default='black') Set the color of the joke text</span>
<code>iconColor</code> : <span>(String, optional, default='#000') Set the color of the like/dislike icons</span>
<code>marginLeft</code> : <span>(String, optional, default='auto') Sets the left margin for the joke container</span>
<code>marginRight</code> : <span>(String, optional, default='auto') Sets the right margin for the joke container</span>
<code>padding</code> : <span>(number, optional, default=10) Sets the padding around the joke text</span>
<code>showTags</code> : <span>(boolean, optional, default=true) Sets whether to display the tags on the joke if any exist
<code>width</code> : <span>(String, optional, default='50%') Set the width of the component</span>