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

SFR-1799/1800: Update page titles for accessibility #454

Merged
merged 4 commits into from
Nov 1, 2023
Merged

SFR-1799/1800: Update page titles for accessibility #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a411e24
update page titles for accessibility
jackiequach Oct 26, 2023
ecfcba0
use template literals
jackiequach Oct 30, 2023
eded581
update page title truncation
jackiequach Nov 1, 2023
38e2fb3
fix failing test
jackiequach Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- Feedback button test PW
- SFR-1797: Remove Playwright tests with clicks on header and footer links
- Update README with C4 diagrams and epub-to-webpub info
- Update Collection, Edition, and Work page titles for accessibility

## [0.17.4]

Expand Down
36 changes: 25 additions & 11 deletions src/__tests__/AdvancedSearch.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,19 @@ describe("Advanced Search clear", () => {
};

await userEvent.click(screen.getByRole("checkbox", { name: "english" }));
inputTerms.forEach(async (val) => {
await userEvent.type(
screen.getByLabelText(val.text),
inputValues[val.text]
);
});
await userEvent.type(
screen.getByLabelText("Keyword"),
inputValues["Keyword"]
);
await userEvent.type(
screen.getByLabelText("Author"),
inputValues["Author"]
);
await userEvent.type(
screen.getByLabelText("Subject"),
inputValues["Subject"]
);
await userEvent.type(screen.getByLabelText("Title"), inputValues["Title"]);
await userEvent.clear(
await screen.findByRole("spinbutton", { name: "From" })
);
Expand All @@ -215,11 +222,18 @@ describe("Advanced Search clear", () => {
screen.getByLabelText("Show only US government documents")
).toBeChecked();

inputTerms.forEach(async (val) => {
expect(await screen.findByRole(val.text)).toHaveValue(
inputValues[val.text]
);
});
expect(await screen.findByRole("textbox", { name: "Keyword" })).toHaveValue(
inputValues["Keyword"]
);
expect(await screen.findByRole("textbox", { name: "Author" })).toHaveValue(
inputValues["Author"]
);
expect(await screen.findByRole("textbox", { name: "Subject" })).toHaveValue(
inputValues["Subject"]
);
expect(await screen.findByRole("textbox", { name: "Title" })).toHaveValue(
inputValues["Title"]
);

await userEvent.click(screen.getByRole("button", { name: "Clear" }));

Expand Down
1 change: 1 addition & 0 deletions src/constants/editioncard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ export const MAX_PUBLISHER_NAME_LENGTH = 80;
export const MAX_PLACE_LENGTH = 80;
export const PLACEHOLDER_COVER_LINK =
"https://test-sfr-covers.s3.amazonaws.com/default/defaultCover.png";
export const MAX_PAGE_TITLE_LENGTH = 45;
2 changes: 1 addition & 1 deletion src/constants/labels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export const documentTitles = {
home: "Digital Research Books Beta | NYPL",
advancedSearch: "Advanced Search | Digital Research Books Beta | NYPL",
search: "Search Results | Digital Research Books Beta | NYPL",
workItem: "Item Details | Digital Research Books Beta | NYPL",
workItem: "Work Details | Digital Research Books Beta | NYPL",
editionItem: "Edition Details | Digital Research Books Beta | NYPL",
readItem: "Read Online | Digital Research Books Beta | NYPL",
collection: "Collection | Digital Research Books Beta | NYPL",
Expand Down
12 changes: 12 additions & 0 deletions src/pages/collection/[collectionId].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
import { GetServerSideProps } from "next";
import Head from "next/head";
import React from "react";
import Collection from "~/src/components/Collection/Collection";

import Layout from "~/src/components/Layout/Layout";
import { MAX_PAGE_TITLE_LENGTH } from "~/src/constants/editioncard";
import { documentTitles } from "~/src/constants/labels";
import { collectionFetcher } from "~/src/lib/api/CollectionApi";
import { CollectionQuery, CollectionResult } from "~/src/types/CollectionQuery";
import { truncateStringOnWhitespace } from "~/src/util/Util";

export const getServerSideProps: GetServerSideProps = async (context) => {
const collectionQuery: CollectionQuery = {
Expand All @@ -31,6 +35,14 @@ const CollectionResults: React.FC<{
}> = ({ collectionResult, collectionQuery }) => {
return (
<Layout>
<Head>
<title>
{`${truncateStringOnWhitespace(
collectionResult.metadata.title,
MAX_PAGE_TITLE_LENGTH
)} | ${documentTitles.collection}`}
</title>
</Head>
<Collection
collectionResult={collectionResult}
collectionQuery={collectionQuery}
Expand Down
13 changes: 12 additions & 1 deletion src/pages/edition/[editionId].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import React from "react";

import Layout from "~/src/components/Layout/Layout";
import Edition from "~/src/components/EditionDetail/Edition";
import { editionFetcher } from "~/src/lib/api/SearchApi";
import { EditionQuery, EditionResult } from "~/src/types/EditionQuery";
import { getBackToSearchUrl } from "~/src/util/LinkUtils";
import { documentTitles } from "~/src/constants/labels";
import Head from "next/head";
import { MAX_PAGE_TITLE_LENGTH } from "~/src/constants/editioncard";
import { truncateStringOnWhitespace } from "~/src/util/Util";

export async function getServerSideProps(context: any) {
const editionQuery: EditionQuery = {
Expand All @@ -26,6 +29,14 @@ export async function getServerSideProps(context: any) {
const WorkResults: React.FC<any> = (props) => {
return (
<Layout>
<Head>
<title>
{`${truncateStringOnWhitespace(
props.editionResult.data.title,
MAX_PAGE_TITLE_LENGTH
)} | ${documentTitles.editionItem}`}
</title>
</Head>
<Edition editionResult={props.editionResult} backUrl={props.backUrl} />
</Layout>
);
Expand Down
13 changes: 12 additions & 1 deletion src/pages/work/[workId].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import Head from "next/head";
import React from "react";

import Layout from "~/src/components/Layout/Layout";
import WorkDetail from "~/src/components/Work/Work";
import { MAX_PAGE_TITLE_LENGTH } from "~/src/constants/editioncard";
import { documentTitles } from "~/src/constants/labels";
import { workFetcher } from "~/src/lib/api/SearchApi";
import { WorkQuery, WorkResult } from "~/src/types/WorkQuery";
import { getBackToSearchUrl } from "~/src/util/LinkUtils";
import { truncateStringOnWhitespace } from "~/src/util/Util";

export async function getServerSideProps(context: any) {
//TODO: Default query
Expand All @@ -27,6 +30,14 @@ export async function getServerSideProps(context: any) {
const WorkResults: React.FC<any> = (props) => {
return (
<Layout>
<Head>
<title>
{`${truncateStringOnWhitespace(
props.workResult.data.title,
MAX_PAGE_TITLE_LENGTH
)} | ${documentTitles.workItem}`}
</title>
</Head>
<WorkDetail workResult={props.workResult} backUrl={props.backUrl} />
</Layout>
);
Expand Down
Loading