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.

Sign up for GitHub

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

added banner to redirect to Orbiter when suitable #1235

Merged
merged 2 commits into from
Oct 25, 2023
+28 −1
Merged

added banner to redirect to Orbiter when suitable #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcbe0a7
added banner to redirect to Orbiter when suitable
Oct 24, 2023
1a663d1
removed banner color declaration
Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .storybook/components/banner/Banner.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.o-ui-sb-banner {
background: var(--o-ui-bg-alias-warning-light);
border-radius: var(--o-ui-br-3);
}
19 changes: 19 additions & 0 deletions .storybook/components/banner/Banner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import "./Banner.css";

import { Div, DivProps } from "@components/html";
import { mergeProps } from "@components/shared";

export function Banner({ children, ...rest }: DivProps) {
return (
<Div
{...mergeProps(
rest,
{
className: "highlight o-ui-sb-banner"
}
)}
>
{children}
</Div>
);
}
1 change: 1 addition & 0 deletions .storybook/components/banner/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "./Banner";
1 change: 1 addition & 0 deletions .storybook/components/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ export * from "./snippet";
export * from "./themed-snippet";
export * from "./package-installation-snippet";
export * from "./preview";
export * from "./banner";
4 changes: 3 additions & 1 deletion docs/getting-started/Installation.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Meta } from "@storybook/addon-docs";
import { PackageInstallationSnippet } from "@stories/components";
import { PackageInstallationSnippet, Banner, ExternalLink } from "@stories/components";
import { Message } from "@components/message";

<Meta
Expand All @@ -9,6 +9,8 @@ import { Message } from "@components/message";

# Installation

<Banner>If you are starting a new project with Workleap, you should use <ExternalLink href="https://wl-orbiter-website.netlify.app/">Orbiter</ExternalLink>.</Banner>

Multiple [NPM packages](https://www.npmjs.com/settings/orbit-ui/packages) compose Orbit. By creating a bundle package named [@sharegate/orbit-ui](https://www.npmjs.com/package/@sharegate/orbit-ui), we simplify the installation process and allow you to install Orbit with just a single package.

> We assume you've already set up [react](https://www.npmjs.com/package/react) and [react-dom](https://www.npmjs.com/package/react-dom). Otherwise, you'll get a warning at installation.
Expand Down
Loading