patternfly / patternfly/patternfly-react

Bug - Password Generator - Inconsistent Demo Layout in Docs (HTML vs TSX Demos)

オープン
#11,633 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Stale
主要言語
TypeScript
スター
862
フォーク
392
平均マージ
4日 8時間
マージ済み PR(30日)
9

説明

Describe the problem

In the docs for Password Generator, there is an issue with the layout of the demo.

The HTML demo uses a FormGroup component, which renders the demo at the correct width (with a max-width of 825px set in the docs framework).

The TSX demo uses the InputGroup component, which seems to be the new recommended React component for this functionality. However the InputGroup demo is rendered at a very small width, making the code editor and the demo code difficult to read:

Image Image

How do you reproduce the problem?

  1. Go to the React docs for Password Generator
  2. See the TSX demo using InputGroup, which is collapsed and has a narrow width.
  3. Compare to the HTML demo using FormGroup which has the proper layout.

Expected behavior

TSX demo for the Password Generator should be displayed with the same layout and width as the HTML demo.

Screenshots

See above

What is your environment?

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Chrome

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

React Password Generator のドキュメントページから始め、TSX InputGroup デモと HTML FormGroup デモを比較します。次に、packages/documentation-framework/templates/mdx.js にあるリンク先のドキュメントフレームワークテンプレートを調べ、TSX デモが HTML デモと同じ読みやすい幅とレイアウトになっていることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
react, typescript
領域
documentation, frontend
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。