https://github.com/pallassystems/react-security-classification-banner

Security Classification Banner based on UK Government Guidance
https://github.com/pallassystems/react-security-classification-banner

classification react security

Last synced: about 5 hours ago
JSON representation

Security Classification Banner based on UK Government Guidance

• Host: GitHub
• URL: https://github.com/pallassystems/react-security-classification-banner
• Owner: PallasSystems
• License: apache-2.0
• Created: 2023-07-28T19:24:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-22T10:55:32.000Z (9 months ago)
• Last Synced: 2024-04-22T12:03:34.090Z (9 months ago)
• Topics: classification, react, security
• Language: TypeScript
• Homepage: https://pallassystems.github.io/react-security-classification-banner/
• Size: 1.97 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React UK Security Classification Banner

A library to generate  UK Security Classification Banners based on [UK Government Guidance](https://www.gov.uk/government/publications/government-security-classifications/government-security-classifications-policy-html). The UK has 3 Classification levels and various rules on handling instructions, this library provides a TSX Component which will generate a banner in the correct colours, with text laid out correctly and accessibility features incorporated.

The UK government guidance has sections for each part of a security classification banner, the library allows users to define a `SecurityClassification` object which has variables for each section. It will parse the object in order to generate a valid result. For example the descriptor 'FOR PUBLIC RELEASE' can't be used above 'OFFICIAL' and so will be dropped on 

## Getting Started

1. Ensure that you have React 18 or later installed

2. Install Peer Dependencies

```bash

npm install react

```

3. Install The Security Classification Banner

```bash

npm install @pallassystems/react-security-classification-banner

```

### Usage

## Develop and Contribute

We welcome questions, ideas, issues and code contributions to this project.

Use the [issues page](https://github.com/PallasSystems/react-security-classification-banner/issues) to get in touch with the community.

If you would like to make a code contribution please fork the repository and create a

[GitHub pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) to the `main` branch.