patternfly / patternfly/patternfly-react

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

Open
#11,633 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Stale
Dominant language
TypeScript
Stars
862
Forks
392
Avg merge
4d 8h
Merged PRs (30d)
9

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the React Password Generator documentation page and compare the TSX InputGroup demo with the HTML FormGroup demo. Inspect the linked docs framework template at packages/documentation-framework/templates/mdx.js, then verify that the TSX demo has the same readable width and layout as the HTML demo.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.