Skip to content

Commit

Permalink
docs: renderIf component (#1784)
Browse files Browse the repository at this point in the history
  • Loading branch information
TahimiLeonBravo committed Aug 20, 2020
1 parent 508680b commit 81d67a0
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/components/RenderIf/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ReactNode } from 'react';

export interface RenderIfProps {
isTrue?: boolean;
children?: ReactNode;
}

export default function(props: RenderIfProps): JSX.Element | null;
2 changes: 2 additions & 0 deletions src/components/RenderIf/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ export default function RenderIf({ isTrue, children }) {
}

RenderIf.propTypes = {
/** Indicates whether the component content is showed or not. If is set to true, then is showed the component content. */
isTrue: PropTypes.bool,
/** The content of the component. */
children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.object]),
};

Expand Down
10 changes: 10 additions & 0 deletions src/components/RenderIf/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

##### RenderIf base use case

```js
import React from 'react';
import { Avatar } from 'react-rainbow-components';

<div className="rainbow-p-vertical_large rainbow-p-left_medium">
RenderIf
</div>
1 change: 1 addition & 0 deletions src/components/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export { default as RadioButtonGroup } from './RadioButtonGroup';
export { default as RadioGroup } from './RadioGroup';
export { default as Rating } from './Rating';
export { default as ReCaptcha } from './ReCaptcha';
export { default as RenderIf } from './RenderIf';
export { default as Select } from './Select';
export { default as Sidebar } from './Sidebar';
export { default as SidebarItem } from './SidebarItem';
Expand Down
1 change: 1 addition & 0 deletions src/components/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export { default as RadioButtonGroup } from './RadioButtonGroup';
export { default as RadioGroup } from './RadioGroup';
export { default as Rating } from './Rating';
export { default as ReCaptcha } from './ReCaptcha';
export { default as RenderIf } from './RenderIf';
export { default as Select } from './Select';
export { default as Sidebar } from './Sidebar';
export { default as SidebarItem } from './SidebarItem';
Expand Down

0 comments on commit 81d67a0

Please sign in to comment.