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.

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

[Doc] Добавить в документации отдельных компонентов пункты о доступности #3035

Open
3 tasks done
eugpoloz opened this issue Aug 23, 2022 · 0 comments
Labels
a11y Доступность (цифровая) docs

Comments

@eugpoloz
Copy link
Contributor

eugpoloz commented Aug 23, 2022

Описание

В рамках этой задачи надо:

  • напилить специальный milestone, например, "Документация по доступности компонентов"
  • составить список компонентов, для которых нужно расписать доступность
  • и завести для каждого неохваченного компонента отдельную задачку

Чеклист

#3337 – пример хорошего PR с внедрением доступности, на который можно равняться


Draft идеи про отедльный файл по доступности

Я бы попробовала делать доку по доступности отдельным файлом (например, Readme.a11y.md) и импортить его в "основную" доку, как советуют тут:

import * as React from "react";
import { HasRootRef } from "../../types";
import "./Div.css";

export interface DivProps
  extends React.HTMLAttributes<HTMLDivElement>,
    HasRootRef<HTMLDivElement> {}

/**
 * @see https://vkcom.github.io/VKUI/#/Div
 *
 * Доступность компонента:
 * @example ./Readme.a11y.md
 */
export const Div = ({ children, getRootRef, ...restProps }: DivProps) => {
  return (
    <div {...restProps} ref={getRootRef} vkuiClass="Div">
      {children}
    </div>
  );
};

Правда, сходу у меня такое не завелось и файл не подтянулся. 🤣

@eugpoloz eugpoloz added docs a11y Доступность (цифровая) labels Aug 23, 2022
@eugpoloz eugpoloz added this to VKUI Aug 23, 2022
@eugpoloz eugpoloz moved this to 🔜 To do in VKUI Aug 23, 2022
@eugpoloz eugpoloz moved this from 🔜 To do to 🗃 Backlog in VKUI Aug 23, 2022
@inomdzhon inomdzhon added this to the a11y. Документация по доступности компонентов milestone Dec 29, 2022
@inomdzhon inomdzhon changed the title [Draft][Doc] Добавить в документации отдельных компонентов пункты о доступности [Doc] Добавить в документации отдельных компонентов пункты о доступности Dec 29, 2022
@eugpoloz eugpoloz removed this from the a11y. Документация по доступности компонентов milestone Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y Доступность (цифровая) docs
Projects
Status: 🗃 Backlog
Development

No branches or pull requests

2 participants