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

Support viewing a control's class #819

Closed
2 tasks
Bronstrom opened this issue Apr 28, 2023 · 4 comments · Fixed by #869
Closed
2 tasks

Support viewing a control's class #819

Bronstrom opened this issue Apr 28, 2023 · 4 comments · Fixed by #869
Assignees
Labels
enhancement New feature or request

Comments

@Bronstrom
Copy link
Contributor

Bronstrom commented Apr 28, 2023

Description

As a user of the OSCAL Viewer/Editor, I would like to be able to view the class of a control.

Acceptance Criteria

  • The class [0 or 1] attribute of a control is displayed properly
  • The class display should be a re-usable component, such that it can be used for groups, params, and other OSCAL syntax that offers @class

Proposed Solution

This could be the element that displays underneath a title of a sub-control and appears as the first element when a control grouping is expanded.

Additional Notes

No response

Implementation

  • I can (or plan to) submit a pull request to implement this
  • Implementing this may result in a breaking change
@Bronstrom Bronstrom added the enhancement New feature or request label Apr 28, 2023
@Bronstrom Bronstrom changed the title Support viewing control class Support viewing a control's class Apr 28, 2023
@brian-ruf-ezd
Copy link
Contributor

brian-ruf-ezd commented May 1, 2023

There will eventually be both recognized and unrecognized classes. Recognized classes will be managed in an enumerated list with both human-friendly and OSCAL-friendly values.

For initial implementation this will display all classes as if they are unrecognized.

Later, the edit functionality ( #820) should offer a list of recognized classes, and for any recognized class, a user-friendly presentation would have to be provided here in addition to the raw presentation for unrecognized classes.

@tuckerzp
Copy link
Contributor

tuckerzp commented May 1, 2023

For initial implementation this will display all classes as if they are unrecognized.

@brian-easyd or @Bronstrom would we be able to expand on this comment and put it as acceptance criteria / additional notes for this issue?

@laurelmay laurelmay self-assigned this May 18, 2023
@laurelmay
Copy link
Contributor

Here is the design that I have at the moment. I used the code we have for generating colors from a string to make it so that a particular string will always appear the same way -- this helps visually distinguish SP800-53 from sp800-53a better. In the future, we might make these colors user-selectable?

image

@tuckerzp
Copy link
Contributor

I used the code we have for generating colors from a string to make it so that a particular string will always appear the same way

I really like this design. I think being able to clearly distinguish class will be very helpful

Bronstrom pushed a commit that referenced this issue May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants