Tweak VisitInput to match "established" Glossary terms

Open
#93 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
28/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
graphql, typescript
Domain
frontend

Research direction

Locate the VisitInput component and all of its usages, then inspect how its label and component name are currently exposed. Clarify whether the change only requires a configurable label or also a renamed component with compatibility for existing uses; done should match the established Glossary term without breaking current VisitInput users.

Written by the indexing model from the issue text.

Description

accepted

"Visit" has been deprecated (in Diamond's GraphQL) for - the more enigmatic - "Instrument Session Id". For reasons.

It should be (at the least) possible to change the label of the current Visit Input to something else, to allow the name change.

However... perhaps the name of the component should be switched over too. In this case it may be better to have two components based on the same underlining code, so as not to break current use of VisitInput - but this is a goodopportunity to refactor the component into more useful parts, usable in future input boxes.

Thoughts?

Dominant language
TypeScript
Stars
8
Forks
3
Avg merge
2d 6h
Merged PRs (30d)
11

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.

More from DiamondLightSource/sci-react-ui

All issues in DiamondLightSource/sci-react-ui

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.