-
Notifications
You must be signed in to change notification settings - Fork 14
/
LinkCodePage.tsx
233 lines (230 loc) · 7.17 KB
/
LinkCodePage.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
import {
DxcTable,
DxcParagraph,
DxcFlex,
DxcLink,
} from "@dxc-technology/halstack-react";
import DocFooter from "@/common/DocFooter";
import QuickNavContainer from "@/common/QuickNavContainer";
import QuickNavContainerLayout from "@/common/QuickNavContainerLayout";
import Code from "@/common/Code";
import Example from "@/common/example/Example";
import nextLink from "./examples/nextLink";
import basicUsage from "./examples/basicUsage";
import routerLink from "./examples/routerLink";
import routerLink6 from "./examples/routerLink6";
import icons from "./examples/icons";
import HeaderDescriptionCell from "@/common/HeaderDescriptionCell";
const sections = [
{
title: "Props",
content: (
<DxcTable>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<HeaderDescriptionCell>Description</HeaderDescriptionCell>
</tr>
</thead>
<tbody>
<tr>
<td>disabled: boolean</td>
<td>
<Code>false</Code>
</td>
<td>If true, the link is disabled.</td>
</tr>
<tr>
<td>inheritColor: boolean</td>
<td>
<Code>false</Code>
</td>
<td>If true, the color is inherited from parent.</td>
</tr>
<tr>
<td>icon: node | string</td>
<td></td>
<td>
Element or path used as the icon that will be placed next to the
link text.
</td>
</tr>
<tr>
<td>iconPosition: 'before' | 'after'</td>
<td>
<Code>'before'</Code>
</td>
<td>Indicates the position of the icon in the component.</td>
</tr>
<tr>
<td>href: string</td>
<td></td>
<td>Page to be opened when the user clicks on the link.</td>
</tr>
<tr>
<td>newWindow: boolean</td>
<td>
<Code>false</Code>
</td>
<td>If true, the page is opened in a new browser tab.</td>
</tr>
<tr>
<td>onClick: function</td>
<td></td>
<td>
If defined, the link will be displayed as a button. This function
will be called when the user clicks the link.
</td>
</tr>
<tr>
<td>children: string</td>
<td></td>
<td>Content of the link.</td>
</tr>
<tr>
<td>margin: string | object</td>
<td></td>
<td>
Size of the margin to be applied to the component ('xxsmall' |
'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
You can pass an object with 'top', 'bottom', 'left' and 'right'
properties in order to specify different margin sizes.
</td>
</tr>
<tr>
<td>tabIndex: number</td>
<td>
<Code>0</Code>
</td>
<td>Value of the tabindex.</td>
</tr>
</tbody>
</DxcTable>
),
},
{
title: "Examples",
subSections: [
{
title: "Basic usage",
content: <Example example={basicUsage} defaultIsVisible />,
},
{
title: "Router links",
content: (
<>
<DxcParagraph>
There are many React based routers, unfortunately all with
different APIs.
</DxcParagraph>
<DxcParagraph>
So we decided to make our link component just an styled HTML
anchor element which allows it to be used in any React based
router. For each API is different, so here are some examples for{" "}
<DxcLink
href="https://reactrouter.com/en/main/hooks/use-href"
newWindow
>
React Router
</DxcLink>{" "}
and{" "}
<DxcLink
href="https://nextjs.org/docs/api-reference/next/link#if-the-child-is-a-functional-component"
newWindow
>
NextJS Link
</DxcLink>
. Some of these examples are just representations of how they
should be implemented but might not work correctly in this
scenario.
</DxcParagraph>
</>
),
subSections: [
{
title: "React router",
content: (
<>
<DxcParagraph>
This is an example of{" "}
<DxcLink
href="https://v5.reactrouter.com/web/api/Route/component"
newWindow
>
React Router
</DxcLink>{" "}
using the prop <Code>component</Code>. Note that this prop is
not available in v6.
</DxcParagraph>
<Example example={routerLink} defaultIsVisible />
</>
),
},
{
title: "React router v6",
content: (
<>
<DxcParagraph>
In{" "}
<DxcLink
href="https://github.com/remix-run/react-router/blob/main/docs/upgrading/v5.md#remove-link-component-prop"
newWindow
>
React Router v6
</DxcLink>{" "}
the prop <Code>component</Code> is no longer available so it
is necessary to use hooks provided by{" "}
<DxcLink
href="https://reactrouter.com/en/main/hooks/use-href"
newWindow
>
React Router v6
</DxcLink>
.
</DxcParagraph>
<Example example={routerLink6} defaultIsVisible />
</>
),
},
{
title: "NextJS Link",
content: (
<>
<DxcParagraph>
This is an example of{" "}
<DxcLink
href="https://nextjs.org/docs/api-reference/next/link#if-the-child-is-a-functional-component"
newWindow
>
NextJS
</DxcLink>{" "}
.
</DxcParagraph>
<Example example={nextLink} defaultIsVisible />
</>
),
},
],
},
{
title: "Icons",
content: <Example example={icons} defaultIsVisible />,
},
],
},
];
const LinkCodePage = () => {
return (
<DxcFlex direction="column" gap="4rem">
<QuickNavContainerLayout>
<QuickNavContainer
sections={sections}
startHeadingLevel={2}
></QuickNavContainer>
</QuickNavContainerLayout>
<DocFooter githubLink="https://github.com/dxc-technology/halstack-react/blob/master/website/screens/components/link/code/LinkCodePage.tsx" />
</DxcFlex>
);
};
export default LinkCodePage;