Skip to content

Commit

Permalink
Add missing export (#130)
Browse files Browse the repository at this point in the history
* Fix ScoreCardTable export

* Add documentation for newly exported ScoreCardTable

* Add changeset
T0RAT0RA authored Dec 6, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent f02d5e5 commit 111a8c1
Showing 5 changed files with 49 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .changeset/neat-wolves-unite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@oriflame/backstage-plugin-score-card': patch
---

Fix ScoreCardTable export and update its documentation
12 changes: 11 additions & 1 deletion plugins/score-card/README.md
Original file line number Diff line number Diff line change
@@ -6,10 +6,20 @@ Welcome to the score-card plugin! Main idea behind it comes from a need to someh

### ScoreBoardPage

Displays list of systems and their scores.
Page that displays list of systems and their scores.

![Score board](./docs/.assets/score-board.png)

### ScoreCardTable

Table that displays list of systems and their scores.

![Score card table](./docs/.assets/score-card-table.png)

| Props | type | Description | Default |
|---------|--------|--------------------|------------------------|
| `title` | string | Title of the table | System scores overview |

### ScoreCard

Displays detail for one system and it's scoring. You may use it in entity detail page in the catalog.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions plugins/score-card/src/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* Copyright 2022 Oriflame
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { scoreCardPlugin, ScoreCardTable, ScoreBoardPage, EntityScoreCardContent } from '.';

describe('score-card exports', () => {
it('should export plugin', () => {
expect(scoreCardPlugin).toBeDefined();
});

it('should export ScoreCardTable', () => {
expect(ScoreCardTable).toBeDefined();
});
it('should export ScoreBoardPage', () => {
expect(ScoreBoardPage).toBeDefined();
});
it('should export EntityScoreCardContent', () => {
expect(EntityScoreCardContent).toBeDefined();
});
});
1 change: 1 addition & 0 deletions plugins/score-card/src/index.ts
Original file line number Diff line number Diff line change
@@ -16,6 +16,7 @@
export {
scoreCardPlugin,
ScoreBoardPage,
ScoreCardTable,
EntityScoreCardContent,
} from './plugin';

0 comments on commit 111a8c1

Please sign in to comment.