Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | 14x 14x 7x 7x 216x 1x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 3x 3x 3x 3x 3x 3x 3x 20x 8x 8x 8x 8x 8x 20x 16x 20x 16x 21x 20x 16x 21x 35x 20x 16x 21x 20x 16x 21x 20x 19x 19x 19x 19x 30x 50x 30x 30x 10x 20x 20x 20x 20x 20x 20x 20x 20x 8x 20x 8x 20x 1x 1x 1x 23x 23x 23x 23x 23x 23x 40x | import { useState, useEffect, useMemo } from "react";
import { Link, useSearchParams } from "react-router-dom";
import {
Strip,
Row,
Col,
MainTable,
Notification,
Pagination,
Chip,
Select,
SearchBox,
} from "@canonical/react-components";
import type { InterfaceItem } from "../../types";
function sortInterfaces(a: InterfaceItem, b: InterfaceItem) {
Iif (a?.status === "published" && b?.status !== "published") {
return -1;
}
if (a?.status !== "published" && b?.status === "published") {
return 1;
}
return 0;
}
const normalize = (value?: string) => (value || "").trim().toLowerCase();
type Props = {
interfacesList: Array<InterfaceItem>;
};
const ITEMS_PER_PAGE = 10;
function InterfacesIndex({ interfacesList }: Props) {
const [searchParams, setSearchParams] = useSearchParams();
const [interfaces, setInterfaces] = useState<Array<InterfaceItem>>([]);
const [loading, setLoading] = useState(false);
const [error, setError] = useState(false);
const searchQuery = searchParams.get("search") || "";
const statusFilter = searchParams.get("status") || "";
const categoryFilter = searchParams.get("category") || "";
const parsedPageNumber = Number.parseInt(searchParams.get("page") || "1", 10);
const currentPageNumber =
Number.isNaN(parsedPageNumber) || parsedPageNumber < 1
? 1
: parsedPageNumber;
const updateSearchParams = (
updates: Record<string, string>,
resetPage = true
) => {
const params = new URLSearchParams(searchParams);
Object.entries(updates).forEach(([key, value]) => {
if (value) {
params.set(key, value);
} else E{
params.delete(key);
}
});
Eif (resetPage) {
params.delete("page");
}
setSearchParams(params);
};
useEffect(() => {
Eif (interfacesList) {
setInterfaces(interfacesList);
setError(false);
setLoading(false);
return;
}
setLoading(true);
fetch("./interfaces.json")
.then((response) => {
if (response.status === 200) {
return response.json();
}
throw response;
})
.then((data) => {
setInterfaces(data?.interfaces || []);
})
.catch(() => {
setError(true);
})
.finally(() => {
setLoading(false);
});
}, [interfacesList]);
const sortedInterfaces = useMemo(
() => [...interfaces].sort(sortInterfaces),
[interfaces]
);
const statusOptions = useMemo(() => {
return Array.from(
new Set(
sortedInterfaces.map((item) => normalize(item.status)).filter(Boolean)
)
).sort();
}, [sortedInterfaces]);
const categoryOptions = useMemo(() => {
return Array.from(
new Set(
sortedInterfaces
.flatMap((item) => item.tags || [])
.map((tag) => normalize(tag))
.filter(Boolean)
)
).sort();
}, [sortedInterfaces]);
const statusSelectOptions = useMemo(
() => [
{ value: "", label: "Status" },
...statusOptions.map((status) => ({
value: status,
label: status.charAt(0).toUpperCase() + status.slice(1),
})),
],
[statusOptions]
);
const categorySelectOptions = useMemo(
() => [
{ value: "", label: "Category" },
...categoryOptions.map((category) => ({
value: category,
label: category.charAt(0).toUpperCase() + category.slice(1),
})),
],
[categoryOptions]
);
const filteredInterfaces = useMemo(() => {
const normalizedSearch = normalize(searchQuery);
const normalizedStatus = normalize(statusFilter);
const normalizedCategory = normalize(categoryFilter);
return sortedInterfaces.filter((item) => {
const itemStatus = normalize(item.status);
const itemTags = (item.tags || []).map((tag) => normalize(tag));
const searchableText = [
item.name,
item.summary,
item.description,
...(item.tags || []),
]
.filter(Boolean)
.join(" ")
.toLowerCase();
if (normalizedSearch && !searchableText.includes(normalizedSearch)) {
return false;
}
Iif (normalizedStatus && itemStatus !== normalizedStatus) {
return false;
}
Iif (normalizedCategory && !itemTags.includes(normalizedCategory)) {
return false;
}
return true;
});
}, [sortedInterfaces, searchQuery, statusFilter, categoryFilter]);
const totalPages = Math.max(
1,
Math.ceil(filteredInterfaces.length / ITEMS_PER_PAGE)
);
const currentPage = Math.min(currentPageNumber, totalPages);
const startIndex = (currentPage - 1) * ITEMS_PER_PAGE;
const currentItems = filteredInterfaces.slice(
startIndex,
startIndex + ITEMS_PER_PAGE
);
useEffect(() => {
Iif (currentPageNumber > totalPages) {
updateSearchParams(
{ page: totalPages > 1 ? totalPages.toString() : "" },
false
);
}
}, [currentPageNumber, totalPages]);
useEffect(() => {
document.title = "Charmhub | Interface catalogue";
}, []);
return (
<>
<Strip type="light">
<Row>
<Col size={4}>
<h1>Interfaces</h1>
</Col>
<Col size={8}>
<p>
Interfaces describe the relation between two charms. This
interface catalogue shows opinionated, standardized interface
specifications for charm relations, outlining the exact behavior
and requirements of how charms interact with one another.
</p>
<p className="u-no-margin--bottom">
To maintain stability across the ecosystem, all interfaces adhere
to a strict standard of backwards compatibility. When designing an
interface, follow{" "}
<a href="https://documentation.ubuntu.com/charmlibs/how-to/design-relation-interfaces/">
these guidelines
</a>{" "}
to ensure backwards compatibility.
</p>
</Col>
</Row>
</Strip>
<Strip>
{error && (
<Notification
severity="negative"
title="Error"
onDismiss={() => {
setError(false);
}}
>
There was a problem fetching interfaces. Please try again in a few
moments.
</Notification>
)}
<Row>
<Col size={5}>
<SearchBox
placeholder="Search interfaces"
externallyControlled
value={searchQuery}
onChange={(value) => {
updateSearchParams({ search: value });
}}
aria-label="Search interfaces"
/>
</Col>
<Col
emptyLarge={9}
size={4}
className="p-form--inline"
style={{ justifyContent: "flex-end" }}
>
<Select
value={statusFilter}
options={statusSelectOptions}
onChange={(event) => {
updateSearchParams({ status: event.target.value });
}}
aria-label="Status"
/>
<Select
value={categoryFilter}
options={categorySelectOptions}
onChange={(event) => {
updateSearchParams({ category: event.target.value });
}}
aria-label="Categories"
/>
</Col>
</Row>
<MainTable
headers={[
{
content: "Interface",
heading: "Interface",
},
{
content: "Status",
heading: "Status",
style: {
width: "120px",
},
},
{
content: "Summary",
heading: "Summary",
},
{
content: "Categories",
heading: "Categories",
},
]}
rows={currentItems.map((item: InterfaceItem) => {
const interfaceName = item?.name || "";
const interfaceStatus = item?.status || "";
const normalizedInterfaceStatus = normalize(interfaceStatus);
const interfaceStatusLabel = interfaceStatus
? interfaceStatus.charAt(0).toUpperCase() +
interfaceStatus.slice(1)
: "";
const statusAppearance =
normalizedInterfaceStatus === "published"
? "positive"
: normalizedInterfaceStatus === "draft"
? "caution"
: normalizedInterfaceStatus === "deprecated"
? "negative"
: "information";
return {
columns: [
{
content: (
<>
{interfaceName && (
<Link to={`/integrations/${interfaceName}`}>
{interfaceName}
</Link>
)}
</>
),
},
{
content: (
<>
{interfaceStatus && (
<Chip
value={interfaceStatusLabel}
appearance={statusAppearance}
className="u-no-margin--bottom"
isReadOnly
/>
)}
</>
),
},
{
content: item?.summary || item?.description || "-",
},
{
content: (
<>
{item?.tags && item.tags.length > 0 && (
<div style={{ display: "flex", flexWrap: "wrap" }}>
{item.tags.map((tag) => (
<Chip
key={tag}
value={
tag
? tag.charAt(0).toUpperCase() + tag.slice(1)
: ""
}
className="u-no-margin--bottom"
isReadOnly
/>
))}
</div>
)}
</>
),
},
],
};
})}
emptyStateMsg={`${
loading ? "Fetching interfaces..." : "No interfaces available"
}`}
responsive
/>
<div className="u-align--right">
<Pagination
currentPage={currentPage}
itemsPerPage={ITEMS_PER_PAGE}
paginate={(pageNumber) => {
updateSearchParams(
{ page: pageNumber > 1 ? pageNumber.toString() : "" },
false
);
}}
totalItems={filteredInterfaces.length}
/>
</div>
</Strip>
</>
);
}
export default InterfacesIndex;
|