Skip to content

JSDoc component documentation #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mngweb merged 1 commit into from
May 25, 2022
Merged

JSDoc component documentation #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/components/Bubble/Bubble.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
import './Bubble.css';

/**
* Component creates speech bubble with or without image, with given header and optional sentences.
* Component accepts following inputs:
* @param {string} bubblePosition - "higher" or "lower" means that due to the "higher" or "lower" position of the bubble on the page, the arrow will be placed appropriately.
* @param {boolean} hasImage - whether the bubble will contain an image
* @param {string} header - header text in bubble
* @param {Array.<string>} sentences - optional additional sentences in the bubble
*/
export default function Bubble(bubblePosition, header = '', sentences = [], hasImage = false) {
const bubble = document.createElement('div');
bubble.classList.add('bubble', bubblePosition);
Expand Down