Skip to content
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

Jump to bottom

refactor: improved text JSDoc #347

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: improved text JSDoc #347

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/components/Text/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ const variants = {
};

/**
* Definition of a card component,the main purpose of
* Definition of a card component, the main purpose of
* which is to neatly display information. Can be both
* interactive and static.
*
* @param variant Variations relating to pre-defined styling of the element.
* @param className Custom classes to be applied to the element.
* @param href A URL for the Link component to point to, making the text interactive.
* @param children Child elements to be rendered within the component.
*/
const Text = ({ variant, className, href, children }: TextProps) => (
Expand All @@ -55,4 +56,4 @@ const Text = ({ variant, className, href, children }: TextProps) => (
</p>
);

export default Text;
export default Text;