Skip to content

Commit

Permalink
fix: modify typedoc, README.md in VisitorComment component
Browse files Browse the repository at this point in the history
  • Loading branch information
seohyunsim committed Oct 15, 2022
1 parent 28956d5 commit e9eb643
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -895,10 +895,9 @@ const App = () => {
progressbarColor="#5f5f5f"
isShowScrollDownIcon={true}
scrollDownIconColor='black'
commentInputPlacehoder={commentInputPlacehoder}
comment='this portfolio is very nice' // Your fetched variable
nickname='dev-portfolio' // Your fetched variable
password='1234' // Your fetched variable
descriptionPlaceholder='write your description...'
nicknamePlaceholder='ID'
passwordPlaceholder='PW'
commentList={commentList} // Your fetched variable
handleCreateComment={handleCreateComment} // Event handling variable
handleChangeDescription={handleChangeDescription} // Event handling variable
Expand Down Expand Up @@ -928,11 +927,10 @@ export default App;
| `progressbarColor` | string | The color of the progress bar that is generated when a scroll event occurs | `'#5f5f5f'` | |
| `isShowScrollDownIcon` | boolean | Whether to display icons that are generated when a scroll event occurs | `true` | |
| `scrollDownIconColor` | string | Color in ScrollDown Icon | `'black'` | Only works when isShowScrollDownIcon is true |
| `comment` | string | the text of visitor comment | `'this portfolio is very nice'` | fetched variable |
| `nickname` | string | the nickname of visitor comment | `'dev-portfolio'`| fetched variable |
| `password` | string | the password of visitor comment | `'1234'` | fetched variable |
| `commentInputPlacehoder` | <a href='https://github.com/modern-agile-team/dev-portfolio/blob/master/src/lib/common/types/ComponentTypes/VisitorCommentType.ts#:~:text=export%20interface-,CommentInputPlaceholderType,-%7B'>CommentInputPlaceholderType</a> | Placeholder in the input that you write in the visitor comment | See "More about VisitorComment's Props" | |
| `commentList` | <a href='https://github.com/modern-agile-team/dev-portfolio/blob/master/src/lib/common/types/ComponentTypes/VisitorCommentType.ts#:~:text=export%20interface-,VisitorCommentListType,-%7B'>VisitorCommentListType</a> | Description, nickname, and date displayed in comment list| See "More about VisitorComment's Props" | fetched variable |
| `descriptionPlaceholder` | string | Placeholder of description area | `'write your description...'` | |
| `nicknamePlaceholder` | string | Placeholder of nickname area | `'ID'` | |
| `passwordPlaceholder` | string | Placeholder of password area | `'PW'` | |
| `commentList` | <a href='https://github.com/modern-agile-team/dev-portfolio/blob/master/src/lib/common/types/ComponentTypes/VisitorCommentType.ts#:~:text=export%20interface-,VisitorCommentListType,-%7B'>VisitorCommentListType</a> | List of Comment such as description, nickname, date | See "More about VisitorComment's Props" | fetched variable |
| `handleCreateComment` | (e?: React.MouseEvent<HTMLButtonElement>) => void | Comments Props for event handling | | |
| `handleChangeDescription` | (e?: React.ChangeEvent<HTMLElement>) => void | Description Props for event handling | | |
| `handleChangeNickname` | (e?: React.ChangeEvent<HTMLElement>) => void | Nickname Props for event handling | | |
Expand Down
2 changes: 2 additions & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ function App() {
listCommentColor="white"
inputFontColor="red"
// inputPlacehoderColor="red"
descriptionPlaceholder="hi"
nicknamePlaceholder="dd"
/>

<CardWrap id="['CardWrap','bi:card-list']">
Expand Down
15 changes: 7 additions & 8 deletions src/lib/components/VisitorComment/VisitorComment.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,10 @@ import ProgressBar from '../ProgressBar/ProgressBar';
/**
*
* @props id: Name to be added to Sidebar
* @props commentList: List of Comment
* @commentList description: Description of your comment
* @commentList nickname: Nickname to display
* @commentList date: Day when comment written
* @props commentList: List of Comment such as description, nickname, date
* @props theme: Theme of Visitor Comment Component (default: basic) "basic" | "box" | "vertical"
* @props backgroundColor: Background color of area that out of comment list component (default: whitesmoke)
* @props buttonColor: Text color of Send Button (default: #1877f2)
* @props commentInputPlacehoder: Placeholder of inputs description, nickname and password
* @props inputBackgroundColor: Background color of input area (default: white)
* @props inputFontColor: Font Color in input box when create comment, user infomation (default: black)
* @props inputPlacehoderColor: Placehoder font Color in input comment, user infomation boxes (default: black)
Expand All @@ -32,9 +28,12 @@ import ProgressBar from '../ProgressBar/ProgressBar';
* @props progressbarColor: Color of progressbar appearing when if comment list overflowed comment area (default: #5f5f5f)
* @props isShowScrollDownIcon: Flag wheter show scroll down icon (default: true)
* @props scrollDownIconColor: Color of scroll down icon (default: black)
* @commentInputPlacehoder desPlaceholder: Placeholder of description area (default: 'write your description...')
* @commentInputPlacehoder nicknamePlaceholder: Placeholder of nickname area (default: 'ID')
* @commentInputPlacehoder passwordPlaceholder: Placeholder of password area (default: 'PW')
* @props descriptionPlaceholder: Placeholder of description area (default: 'write your description...')
* @props nicknamePlaceholder: Placeholder of nickname area (default: 'ID')
* @props passwordPlaceholder: Placeholder of password area (default: 'PW')
*
* @refer
* If you want to check the value of commentList please check the following link. {@link https://github.com/modern-agile-team/dev-portfolio#more-about-visitorcomments-props}
*/

const VisitorComment = (props: VisitorCommentPropsType) => {
Expand Down

0 comments on commit e9eb643

Please sign in to comment.