-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update ReadMes, add storybook entry page for ai pkg
- Loading branch information
Showing
4 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import { Footer, TableOfContent } from '@sb/components'; | ||
import { Markdown, Meta } from '@storybook/blocks'; | ||
import ReadMe from '../packages/ai/README.md?raw'; | ||
|
||
<Meta title="AI / Docs" /> | ||
|
||
<TableOfContent /> | ||
|
||
<Markdown>{ReadMe.split('## Documentation')[0].trim()}</Markdown> | ||
|
||
<Footer /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# @ui5/webcomponents-ai-react | ||
|
||
React wrapper for the [@ui5/webcomponents-ai](https://sap.github.io/ui5-webcomponents/components/ai/) web components. | ||
|
||
## Installation | ||
|
||
To consume `@ui5/webcomponents-ai-react`, you need to install the npm modules and required peer dependencies: | ||
|
||
```bash | ||
npm install @ui5/webcomponents-ai-react @ui5/webcomponents-ai | ||
``` | ||
|
||
## Provided assets | ||
|
||
| Assets | Module | Notes | | ||
| ---------------- | -------------------------------------- | ------------------------------------------------------ | | ||
| `i18n`, `themes` | `@ui5/webcomponents-ai/dist/Assets.js` | Theming parameters and translations for the components | | ||
|
||
## UI5 Web Components Documentation and Patterns | ||
|
||
- Components: https://sap.github.io/ui5-webcomponents/components/ai/ | ||
- Patterns: https://sap.github.io/ui5-webcomponents/components/patterns/ | ||
|
||
## Documentation | ||
|
||
You can find an interactive documentation in our [Storybook](https://sap.github.io/ui5-webcomponents-react/). | ||
|
||
## Contribute | ||
|
||
Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents-react/blob/main/CONTRIBUTING.md). | ||
|
||
## License | ||
|
||
Please see our [LICENSE](https://github.com/SAP/ui5-webcomponents-react/blob/main/LICENSE) for copyright and license information. | ||
Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/ui5-webcomponents-react). |