Skip to content

Commit 5aa226a

Browse files
committed
jsdoc and doc fixes
1 parent 20f47a5 commit 5aa226a

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

boilerplate/app/components/Icon.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ type IconProps = Omit<ViewProps, "style"> & BaseIconProps
4646
* A component to render a registered icon.
4747
* It is wrapped in a <TouchableOpacity />
4848
* @see [Documentation and Examples]{@link https://docs.infinite.red/ignite-cli/boilerplate/app/components/Icon/}
49-
* @param {IconProps} props - The props for the `Icon` component.
50-
* @returns {JSX.Element} The rendered `Icon` component.
49+
* @param {PressableIconProps} props - The props for the `PressableIcon` component.
50+
* @returns {JSX.Element} The rendered `PressableIcon` component.
5151
*/
5252
export function PressableIcon(props: PressableIconProps) {
5353
const {

docs/boilerplate/app/components/Icon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 35
44

55
# Icon
66

7-
Ignite's `Icon` and `PressableIcon` Components renders an icon using predefined icon images. You can use those, override them, or customize this component to create any number of image based icons. `PressableIcon` will wrap the icon in a [`TouchableOpacity`](https://reactnative.dev/docs/touchableopacity) component, `Icon` will use a [`View`](https://reactnative.dev/docs/view) component.
7+
Ignite's `Icon` and `PressableIcon` Components render an icon using predefined icon images. You can use those, override them, or customize this component to create any number of image based icons. `PressableIcon` will wrap the icon in a [`TouchableOpacity`](https://reactnative.dev/docs/touchableopacity) component, `Icon` will use a [`View`](https://reactnative.dev/docs/view) component.
88

99
![icon-component](https://github.com/user-attachments/assets/25888c72-8bd9-4cbd-b55f-909b0f6b0bca)
1010

0 commit comments

Comments
 (0)