首页 >web前端 >js教程 >可访问的组件:分页

可访问的组件:分页

Barbara Streisand
Barbara Streisand原创
2024-11-03 00:46:03886浏览

今天我们将了解如何从头开始创建分页并使其可访问和可重用。希望对您有帮助,欢迎在文末留言评论!

Github:https://github.com/micaavigliano/accessible-pagination
项目:https://accessible-pagination.vercel.app/

自定义钩子来获取数据

const useFetch = <T,>(url: string, currentPage: number = 0, pageSize: number = 20) => {
  const [data, setData] = useState<T | null>(null);
  const [loading, setLoading] = useState<boolean>(true);
  const [error, setError] = useState<boolean>(false);

  useEffect(() => {
    const fetchData = async() => {
      setLoading(true);
      setError(false);

      try {
        const response = await fetch(url);
        if (!response.ok) {
          throw new Error('network response failed')
        }
        const result: T = await response.json() as T;
        setData(result)
      } catch (error) {
        setError(true)
      } finally {
        setLoading(false);
      }
    };

    fetchData()
  }, [url, currentPage, pageSize]);

  return {
    data,
    loading,
    error,
  }
};
  1. 我们将生成一个具有通用类型的自定义钩子。这将允许我们指定使用此钩子时期望的数据类型
  2. 让我们等待3个参数。一个用于 url,我们将在其中获取数据,currentPage 是我们所在的页面,默认情况下它是 0,pageSize 是数字我们每页将包含的项目数,默认情况下为 20(您可以更改此值)。
  3. 在我们的状态 const [data, setData] = useState(空);我们将其传递给通用类型 T,因为当我们将它用于不同的数据请求时,我们将期望不同类型的数据。

分页

为了使页面可访问,我们必须考虑以下几点:

  • 焦点必须穿过页面的所有交互元素,并有一个可见的指示器
  • 为了确保与屏幕阅读器的良好交互,我们必须正确使用区域、属性和状态
  • 页面必须分组在标签内,并包含将其标识为页面本身的 aria-label。
  • 分页中的每个项目都必须包含 aria-setsize 和 aria-pointset。现在,它们是做什么用的? aria-setsize 用于计算分页列表中的项目总数。屏幕阅读器将按如下方式宣布:

Componentes accesibles: Paginación

aria-pointset 用于计算该项目在页面上所有项目中的位置。屏幕阅读器将按如下方式宣布:

Componentes accesibles: Paginación

  • 每个项目都必须有一个 aria-label,以便能够识别单击该按钮时我们将转到哪个页面。
  • 有按钮可以转到下一个/上一个元素,并且每个按钮都必须有其相应的 aria-label
  • 如果我们的分页包含省略号,则必须使用 aria-label 正确标记它
  • 每次我们进入新页面时,屏幕阅读器都必须宣布我们所在的页面以及有多少个新项目,如下所示。

Componentes accesibles: Paginación

为了实现这一点,我们将对其进行如下编码:

const useFetch = <T,>(url: string, currentPage: number = 0, pageSize: number = 20) => {
  const [data, setData] = useState<T | null>(null);
  const [loading, setLoading] = useState<boolean>(true);
  const [error, setError] = useState<boolean>(false);

  useEffect(() => {
    const fetchData = async() => {
      setLoading(true);
      setError(false);

      try {
        const response = await fetch(url);
        if (!response.ok) {
          throw new Error('network response failed')
        }
        const result: T = await response.json() as T;
        setData(result)
      } catch (error) {
        setError(true)
      } finally {
        setLoading(false);
      }
    };

    fetchData()
  }, [url, currentPage, pageSize]);

  return {
    data,
    loading,
    error,
  }
};

当页面停止加载时,我们将使用 currentPage 和我们正在加载的新数组的长度设置一条新消息。

现在是的!让我们看看文件 pagination.tsx

中的代码结构如何

该组件需要五个道具

const [statusMessage, setStatusMessage] = useState<string>("");

useEffect(() => {
    window.scrollTo({ top: 0, behavior: 'smooth' });
    if (!loading) {
      setStatusMessage(`Page ${currentPage} loaded. Displaying ${data?.near_earth_objects.length || 0} items.`);
    }
  }, [currentPage, loading]);
  • currentPage 将引用当前页面。我们将通过在要使用分页的组件中来处理此问题,如下所示: const [currentPage, setCurrentPage] = useState(1);
  • totalPages 是指 API
  • 包含的要显示的项目总数。
  • nextPage 此函数将允许我们转到下一页并更新 currentPage 状态,如下所示:
interface PaginationProps {
  currentPage: number;
  totalPages: number;
  nextPage: () => void;
  prevPage: () => void;
  goToPage: (page: number) => void;
}
  • prevPage 此函数将允许我们转到当前页面的上一页并更新 currentPage 状态
const handlePageChange = (newPage: number) => {
    setCurrentPage(newPage); 
  };

  const nextPage = () => {
    if (currentPage < totalPages) {
      handlePageChange(currentPage + 1);
    }
  };
  • goToPage 这个函数需要一个数字参数,它是每个项目必须能够转到所需页面的函数。让我们按如下方式使其工作:
const prevPage = () => {
    if (currentPage > 1) {
      handlePageChange(currentPage - 1);
    }
  };

为了使我们的分页变得生动,我们还需要一步,创建我们将在列表中迭代的数组!为此,我们必须遵循以下步骤:

  1. 创建一个函数,在本例中我将其命名为 getPageNumbers
  2. 为列表中的第一个和最后一个项目创建变量。
  3. 为左侧的省略号创建一个变量。根据我自己的决定,我的省略号将位于列表的第四个元素之后。
  4. 为右侧的省略号创建一个变量。根据我自己的决定,我的省略号将放在列表中的三个项目之前。
  5. 创建一个函数,返回一个数组,其中 5 个项目始终居中,即当前页面、前两个项目和后两个项目。如果需要,我们将排除第一页和最后一页 const pagesAroundCurrent = [currentPage - 2, currentPage - 1, currentPage, currentPage 1, currentPage 2].filter(page => page >firstPage && page
  6. 对于最后一个变量,我们将创建一个包含所有先前创建的变量的数组。
  7. 最后,我们将过滤掉空元素并返回数组。

我们将通过该数组来获取页面中的项目列表,如下所示:

const useFetch = <T,>(url: string, currentPage: number = 0, pageSize: number = 20) => {
  const [data, setData] = useState<T | null>(null);
  const [loading, setLoading] = useState<boolean>(true);
  const [error, setError] = useState<boolean>(false);

  useEffect(() => {
    const fetchData = async() => {
      setLoading(true);
      setError(false);

      try {
        const response = await fetch(url);
        if (!response.ok) {
          throw new Error('network response failed')
        }
        const result: T = await response.json() as T;
        setData(result)
      } catch (error) {
        setError(true)
      } finally {
        setLoading(false);
      }
    };

    fetchData()
  }, [url, currentPage, pageSize]);

  return {
    data,
    loading,
    error,
  }
};

以下是如何制作可重用且易于访问的分页!就我个人而言,我学习了如何从头开始创建页面,因为我必须在实时编码中实现它,我希望我的经验对您的职业生涯有所帮助,并且您可以实现甚至改进它!

您好,
云母

以上是可访问的组件:分页的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn