99 lines
5.6 KiB
JavaScript
99 lines
5.6 KiB
JavaScript
import { useEffect } from 'react'
|
|
import { useDispatch } from 'react-redux'
|
|
import InputText from '../../../components/Input/InputText'
|
|
import Title from '../../../components/Typography/Title'
|
|
import Subtitle from '../../../components/Typography/Subtitle'
|
|
import ErrorText from '../../../components/Typography/ErrorText'
|
|
import HelperText from '../../../components/Typography/HelperText'
|
|
|
|
import { setPageTitle, showNotification } from '../../common/headerSlice'
|
|
import TitleCard from '../../../components/Cards/TitleCard'
|
|
|
|
function DocComponentsContent(){
|
|
|
|
const dispatch = useDispatch()
|
|
|
|
const updateFormValue = () => {
|
|
// Dummy function for input text component
|
|
}
|
|
|
|
return(
|
|
<>
|
|
<article className="prose">
|
|
<h1 className="" >Components</h1>
|
|
|
|
We have added some global components that are used commonly inside the project.
|
|
|
|
{/* Typography*/}
|
|
<h2 id="component1">Typography</h2>
|
|
<div>
|
|
These components are present under <span className="badge mt-0 mb-0 badge-ghost">/components/Typography</span> folder. It accepts styleClass as props which can be used to pass additional className for style. It has following components which you can import and use it -
|
|
<div className="mockup-code mt-4">
|
|
<pre className='my-0 py-0'><code>{'import Title from "../components/Typography/Title"\n <Title>Your Title here</Title>'}</code></pre>
|
|
</div>
|
|
<ul>
|
|
<li><span className='font-bold'>Title</span> - Use this component to show title
|
|
<Title>Title Example</Title>
|
|
</li>
|
|
<li><span className='font-bold'>Subtitle</span> - Component that shows text smaller than title
|
|
<Subtitle styleClass="mt-4 mb-6">Subtitle Example</Subtitle>
|
|
</li>
|
|
<li><span className='font-bold'>ErrorText</span> - Used for showing error messages
|
|
<ErrorText styleClass="mt-2">Error Text Example</ErrorText>
|
|
</li>
|
|
<li><span className='font-bold'>HelperText</span> - Used for showing secondary message
|
|
<HelperText styleClass="">Helper Text Example</HelperText></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
{/* Form Input*/}
|
|
<h2 id="component2">Form Input</h2>
|
|
<p>
|
|
Many times we have to use form input like text, select one or toogle and in every file we have to handle its state management, here we have added global form component that can be used in any file and state variables can be managed by passing props to it. It is present in <span className="badge mt-0 mb-0 badge-ghost">/components/Input</span> folder.
|
|
</p>
|
|
Ex-
|
|
<div className="mockup-code mt-4">
|
|
<pre className='my-0 py-0'><code>{'const INITIAL_LEAD_OBJ = {\n first_name : "", \n last_name : "", \n email : "" \n } \n const [leadObj, setLeadObj] = useState(INITIAL_LEAD_OBJ) \n const updateFormValue = ({updateType, value}) => {\n setErrorMessage("") \n setLeadObj({...leadObj, [updateType] : value})\n }\n\n<InputText type="text" defaultValue={leadObj.first_name} \n updateType="first_name" containerStyle="mt-4" \n labelTitle="First Name" updateFormValue={updateFormValue}/>'}</code></pre>
|
|
</div>
|
|
<InputText type="text" defaultValue={"input value"} updateType="first_name" containerStyle="mt-3" labelTitle="Label Title" updateFormValue={updateFormValue}/>
|
|
|
|
|
|
<p> This example is from add new lead modal, here we are importing component for creating text input and passing some props to handle its content and state variable. Description of props are as follows - </p>
|
|
<ul>
|
|
<li><span className='font-bold'>type</span> - Input type value like number, date, time etc.. </li>
|
|
<li><span className='font-bold'>updateType</span> - This is used to update state variable in parent component</li>
|
|
<li><span className='font-bold'>containerStyle</span> - Style class for container of input, which include label as well</li>
|
|
<li><span className='font-bold'>labelTitle</span> - Title of the label</li>
|
|
<li><span className='font-bold'>updateFormValue</span> - Function of parent component to update state variable</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
{/* Cards */}
|
|
<h2 id="component3">Cards</h2>
|
|
<p>
|
|
<a href="https://daisyui.com/components/card/" target="_blank">Daisy UI</a> already have many cards layout, on top of that we have added one card component that accept title props and shows children inside its body. Also there is a divider between title and body of card. On more provision has been added to add buttons on top left side of card using TopSideButtons props (check leads page).
|
|
|
|
</p>
|
|
Ex -
|
|
<div className="mockup-code mt-4">
|
|
<pre className='my-0 py-0'><code>{'<TitleCard title={"Card Title"}> <h1>Card Body</h1></TitleCard>'}</code></pre>
|
|
</div>
|
|
<div className='p-8 bg-base-300 rounded-lg mt-4'>
|
|
<TitleCard title={"Card Title"}> <h1>Card Body</h1></TitleCard>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div className='h-24'></div>
|
|
|
|
|
|
</article>
|
|
</>
|
|
)
|
|
}
|
|
|
|
export default DocComponentsContent |