paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

Deprecate packages

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:49:24 +02:00
parent 5cb829bb79
commit 64164776a0
5 changed files with 18 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/org-react/README.md
+2 -30
View File
@@ -1,31 +1,3 @@
# org-react
# Deprecated
## features
- Group list picker component
### GroupListPicker
The `GroupListPicker` component displays a select box which also has autocomplete functionality.
To use the `GroupListPicker` component you'll need to import it and add it to your desired place.
```diff
+ import { GroupListPicker } from '@backstage/plugin-org-react';
+ import React, { useState } from 'react';
+ const [group, setGroup] = useState<GroupEntity | undefined>();
<Grid container spacing={3}>
<Grid item xs={12}>
+ <GroupListPicker groupTypes={['team']} placeholder='Search for a team' onChange={setGroup} defaultValue='Team A'/>
</Grid>
</Grid>
```
The `GroupListPicker` comes with four props:
- `groupTypes`: gives the user the option which group types the component should load. If no value is provided all group types will be loaded in;
- `placeholder`: the placeholder that the select box in the component should display. This might be helpful in informing your users what the functionality of the component is.
- `onChange`: a prop to help the user to give access to the selected group
- `defaultValue`: gives the user the option to define a default value that will be shown initially before making a selection
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-org-react` instead.
plugins/org-react/package.json
+4 -2
View File
@@ -2,7 +2,8 @@
"name": "@backstage/plugin-org-react",
"version": "0.1.23",
"backstage": {
"role": "web-library"
"role": "web-library",
"moved": "@backstage-community/plugin-org-react"
},
"publishConfig": {
"access": "public",
@@ -59,5 +60,6 @@
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
}
},
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-org-react instead."
}