@redocly/theme-experimental 0.0.0-beta-20240215154132

package/LICENSE

@@ -0,0 +1 @@
+(c) Copyright 2023 Redocly Inc, all rights reserved.

package/README.md

@@ -0,0 +1 @@
+For more details, contact team@redocly.com.

package/markdoc/Cards/Card.stories.tsx

@@ -0,0 +1,37 @@
+import React from 'react';
+
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { Card } from './Card';
+
+type Story = StoryObj<typeof Card>;
+
+const meta: Meta<typeof Card> = {
+  title: 'Components/Card',
+  component: Card,
+};
+
+export default meta;
+
+export const Default: Story = {
+  args: {
+    title: 'Card Links',
+    links: {
+      type: 'group' as const,
+      label: 'Card Links',
+      items: [
+        {
+          type: 'link' as const,
+          link: '#1',
+          label: 'Link 1',
+        },
+        {
+          type: 'link' as const,
+          link: '#2',
+          label: 'Link 2',
+        },
+      ],
+    },
+  },
+  render: (args) => <Card {...args} />,
+};

package/markdoc/Cards/Card.tsx

@@ -0,0 +1,55 @@
+import React from 'react';
+import styled from 'styled-components';
+import { Link } from '@redocly/theme/components/Link/Link';
+import { H3 } from '@redocly/theme/components/Typography/H3';
+import { useThemeHooks } from '@redocly/theme/core/hooks';
+
+import type { ResolvedNavItem } from '@redocly/theme/core/types';
+
+export interface CardProps {
+  title?: string;
+  icon?: string;
+  links: ResolvedNavItem;
+  className?: string;
+}
+
+export function Card(props: CardProps): JSX.Element {
+  const { useTranslate } = useThemeHooks();
+  const { translate } = useTranslate();
+  return (
+    <CardWrapper data-component-name="Cards/Card" className={props.className}>
+      {props.icon && <img src={props?.icon} alt={props?.title} />}
+      {props.title && <H3>{props.title}</H3>}
+      {props.links.items && (
+        <CardLinksList>
+          {props.links.items.map((item) => (
+            <li key={item.label}>
+              <Link to={item.link as string}>
+                {translate(item.labelTranslationKey, item.label)}
+              </Link>
+            </li>
+          ))}
+        </CardLinksList>
+      )}
+    </CardWrapper>
+  );
+}
+
+const CardWrapper = styled.div`
+  border-radius: 10px;
+  box-shadow: 0 10px 30px 0 rgba(35, 35, 35, 0.1);
+  padding: 20px;
+  margin: 0 20px 20px 0;
+  min-width: 25%;
+  font-family: var(--font-family-base);
+`;
+
+const CardLinksList = styled.ul`
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+
+  li {
+    margin-bottom: 10px;
+  }
+`;

package/markdoc/Cards/CardsBlock.tsx

@@ -0,0 +1,10 @@
+import styled from 'styled-components';
+
+export const CardsBlock = styled.div.attrs<{ className?: string }>(({ className }) => ({
+  'data-component-name': 'Cards/CardsBlock',
+  className,
+}))`
+  display: flex;
+  padding: 20px 0;
+  justify-content: space-between;
+`;

package/markdoc/Cards/__tests__/Card.test.tsx

@@ -0,0 +1,63 @@
+import React from 'react';
+
+import { Card } from '../Card';
+import { renderWithRouter } from '../../../../../tests/utils/';
+
+jest.mock('@redocly/theme/hooks/useThemeHooks');
+
+const links = {
+  type: 'group' as const,
+  label: 'Card Links',
+  items: [
+    {
+      type: 'link' as const,
+      link: '#1',
+      label: 'Link 1',
+    },
+    {
+      type: 'link' as const,
+      link: '#2',
+      label: 'Link 2',
+    },
+  ],
+};
+
+describe('Card', () => {
+  const props = {
+    title: 'Example Card',
+    icon: 'example.png',
+    links,
+  };
+
+  it('renders', () => {
+    const { container } = renderWithRouter(<Card title="Card Links" links={links} />);
+
+    expect(container.firstChild).toMatchSnapshot();
+  });
+
+  it('renders the title when provided', () => {
+    const screen = renderWithRouter(<Card {...props} />);
+    expect(screen.getByText('Example Card')).toBeInTheDocument();
+  });
+
+  it('renders the icon when provided', () => {
+    const screen = renderWithRouter(<Card {...props} />);
+    expect(screen.getByAltText('Example Card')).toHaveAttribute('src', 'example.png');
+  });
+
+  it('renders the links when provided', () => {
+    const screen = renderWithRouter(<Card {...props} />);
+    expect(screen.getByText('Link 1')).toHaveAttribute('href', '/#1');
+    expect(screen.getByText('Link 2')).toHaveAttribute('href', '/#2');
+  });
+
+  it('does not render the title when not provided', () => {
+    const { container } = renderWithRouter(<Card links={props.links} />);
+    expect(container.querySelector('h3')).toBeNull();
+  });
+
+  it('does not render the icon when not provided', () => {
+    const { container } = renderWithRouter(<Card title={props.title} links={props.links} />);
+    expect(container.querySelector('img')).toBeNull();
+  });
+});

package/markdoc/Cards/__tests__/CardsBlock.test.tsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+
+import { CardsBlock } from '../CardsBlock';
+
+describe('CardsBlock', () => {
+  it('renders', () => {
+    const { container } = render(<CardsBlock></CardsBlock>);
+
+    expect(container.firstChild).toMatchSnapshot();
+  });
+});

package/markdoc/Cards/index.ts

@@ -0,0 +1,2 @@
+export * from './Card';
+export * from './CardsBlock';

package/markdoc/CodeStep/CodeStep.tsx

@@ -0,0 +1,67 @@
+import React, { useRef, useContext, useEffect, useCallback } from 'react';
+import styled from 'styled-components';
+
+import type { PropsWithChildren } from 'react';
+
+import { CodeGuideContext, useCodeStepHandlers } from '@portal/CodeGuide';
+
+interface CodeStepProps {
+  bindTo: string;
+}
+
+export function CodeStep({ bindTo, children }: PropsWithChildren<CodeStepProps>) {
+  const context = useContext(CodeGuideContext);
+
+  const node = useRef<HTMLDivElement | null>(null);
+
+  const isSectionActive = context.activeDocsSection === bindTo;
+  const [file, lines] = bindTo.split('#');
+
+  const { onScroll, activateSection } = useCodeStepHandlers({
+    nodeRef: node,
+    bindTo,
+    context: context,
+  });
+
+  const scrollListener = useCallback(() => {
+    onScroll(context.codeBlock);
+  }, [context.codeBlock, onScroll]);
+
+  useEffect(() => {
+    window.addEventListener('scroll', scrollListener);
+
+    return () => {
+      window.removeEventListener('scroll', scrollListener);
+    };
+  }, [context.codeBlock, scrollListener]);
+
+  const setRef = (instance?: HTMLDivElement | null) => {
+    if (instance) {
+      node.current = instance;
+    }
+  };
+
+  return (
+    <Wrapper
+      onClick={() => activateSection(file, lines, context.codeBlock)}
+      active={isSectionActive}
+      ref={setRef}
+    >
+      {children}
+    </Wrapper>
+  );
+}
+
+const Wrapper = styled.div<{ active: boolean }>`
+  padding: 0 32px 16px;
+  box-sizing: border-box;
+  border-left: 3px solid;
+  border-left-color: ${({ active }) => (active ? 'var(--color-primary-base)' : 'transparent')};
+  background-color: ${({ active }) => (active ? 'var(--bg-color-raised)' : 'transparent')};
+  border-top: 1px solid #cbccd1;
+  cursor: pointer;
+
+  &:hover {
+    border-left-color: ${({ active }) => (active ? 'var(--color-primary-base)' : '#cbccd1')};
+  }
+`;

package/markdoc/components.tsx

@@ -0,0 +1,2 @@
+export { CodeStep } from './CodeStep/CodeStep';
+export * from './Cards/index';

package/markdoc/schema.ts

@@ -0,0 +1,23 @@
+import type { Schema } from '@markdoc/markdoc';
+
+export const codeStep: Schema = {
+  attributes: {
+    bindTo: { type: String, required: false },
+  },
+  render: 'CodeStep',
+};
+
+export const card: Schema = {
+  attributes: {
+    title: { type: String, required: false },
+    icon: { type: String, required: false },
+    links: { type: String },
+  },
+  selfClosing: true,
+  render: 'Card',
+};
+
+export const cardsBlock: Schema = {
+  attributes: {},
+  render: 'CardsBlock',
+};

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@redocly/theme-experimental",
+  "version": "0.0.0-beta-20240215154132",
+  "description": "Experimental UI components lib",
+  "keywords": [
+    "theme-experimental",
+    "redocly"
+  ],
+  "author": "team@redocly.com",
+  "license": "SEE LICENSE IN LICENSE",
+  "exports": {
+    "./package.json": "./package.json",
+    "./src/": "./src/"
+  },
+  "peerDependencies": {
+    "lodash.throttle": "^4.1.1",
+    "prismjs": "^1.28.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "react-router-dom": "^6.21.1",
+    "styled-components": "^4.1.1 || ^5.3.11",
+    "styled-system": "^5.1.5",
+    "@markdoc/markdoc": "0.4.0"
+  },
+  "devDependencies": {
+    "@storybook/addon-actions": "7.6.4",
+    "@storybook/addon-essentials": "7.6.4",
+    "@storybook/addon-interactions": "7.6.4",
+    "@storybook/addon-links": "7.6.4",
+    "@storybook/addon-viewport": "7.6.4",
+    "@storybook/addons": "7.6.4",
+    "@storybook/core-common": "7.6.4",
+    "@storybook/node-logger": "7.6.4",
+    "@storybook/react": "7.6.4",
+    "@storybook/react-webpack5": "7.6.4",
+    "@storybook/testing-library": "0.2.2",
+    "@storybook/theming": "7.6.4",
+    "@testing-library/jest-dom": "6.1.5",
+    "@testing-library/react": "14.1.2",
+    "@testing-library/user-event": "14.5.1",
+    "@types/highlight-words-core": "1.2.3",
+    "@types/jest": "29.5.11",
+    "@types/jest-when": "3.5.5",
+    "@types/lodash.throttle": "4.1.9",
+    "@types/node": "18.19.3",
+    "@types/prismjs": "1.26.3",
+    "@types/react": "18.2.45",
+    "@types/react-dom": "18.2.17",
+    "@types/styled-components": "5.1.34",
+    "@types/styled-system": "5.1.22",
+    "@typescript-eslint/eslint-plugin": "5.55.0",
+    "@typescript-eslint/parser": "5.55.0",
+    "chromatic": "6.17.2",
+    "concurrently": "7.6.0",
+    "jest": "29.5.0",
+    "jest-environment-jsdom": "29.5.0",
+    "jest-styled-components": "7.2.0",
+    "jest-when": "3.6.0",
+    "json-schema-to-ts": "2.7.2",
+    "lodash.throttle": "4.1.1",
+    "npm-run-all": "4.1.5",
+    "react-refresh": "0.14.0",
+    "react-router-dom": "6.21.1",
+    "storybook": "7.6.4",
+    "storybook-addon-pseudo-states": "2.1.2",
+    "storybook-design-token": "3.0.0-beta.6",
+    "styled-components": "5.3.11",
+    "styled-system": "5.1.5",
+    "ts-jest": "29.1.1",
+    "ts-node": "10.9.1",
+    "ts-node-dev": "2.0.0",
+    "tsc-alias": "1.8.3",
+    "tsconfig-paths": "4.2.0",
+    "tsconfig-paths-webpack-plugin": "3.5.2",
+    "typescript": "5.2.2",
+    "webpack": "5.88.2"
+  },
+  "dependencies": {
+    "@redocly/theme": "^0.0.0-beta-20240215154132"
+  },
+  "scripts": {
+    "start": "npm-run-all --parallel storybook storybook:tokens:watch",
+    "watch": "tsc -p tsconfig.build.json && (concurrently \"tsc -w -p tsconfig.build.json\" \"tsc-alias -w -p tsconfig.build.json\")",
+    "ts:check": "tsc --noEmit --skipLibCheck",
+    "clean": "rm -rf lib",
+    "compile": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "build": "npm run clean && npm run compile",
+    "storybook": "storybook dev -p 6007",
+    "storybook:build": "npm run storybook:tokens && storybook build",
+    "storybook:tokens": "ts-node scripts/generate-css-tokens.ts",
+    "storybook:tokens:watch": "ts-node-dev --respawn scripts/generate-css-tokens.ts"
+  }
+}

package/src/layouts/CodeGuide/CodeDemo.tsx

@@ -0,0 +1,53 @@
+import React from 'react';
+import styled from 'styled-components';
+import { CodeBlock } from '@redocly/theme/components/CodeBlock/CodeBlock';
+
+import { CodeGuideContext, useCodeGuideHighlightLines } from '@portal/CodeGuide';
+
+export function CodeDemo() {
+  const { highlightedLines, activeCodeTab, setCurrentCodeSample, setCodeNode, codeGuideFiles } =
+    React.useContext(CodeGuideContext);
+
+  useCodeGuideHighlightLines(highlightedLines);
+
+  const codeBlockRef = React.useRef<HTMLPreElement | null>(null);
+
+  const setRef = (instance?: HTMLPreElement | null) => {
+    if (instance) {
+      codeBlockRef.current = instance;
+      setCodeNode(codeBlockRef);
+    }
+  };
+
+  const activeCodeExample = codeGuideFiles.find(({ name }) => activeCodeTab === name);
+
+  return (
+    <CodeDemoWrapper>
+      <CodeBlock
+        source={activeCodeExample?.content}
+        lang={activeCodeExample?.lang}
+        withLineNumbers
+        header={{
+          controls: {
+            copy: {},
+          },
+        }}
+        codeBlockRef={setRef}
+        codeBlockMaxHeight="75vh"
+        hideCodeColors={true}
+        tabs={{
+          files: codeGuideFiles,
+          activeTabName: activeCodeTab,
+          handleTabSwitch: setCurrentCodeSample,
+        }}
+      />
+    </CodeDemoWrapper>
+  );
+}
+
+const CodeDemoWrapper = styled.div`
+  background-color: var(--samples-panel-controls-background-color);
+  border-radius: 0 var(--global-border-radius);
+  padding: 32px 0;
+  min-height: 85vh;
+`;

package/src/layouts/CodeGuide/CodeGuide.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import styled from 'styled-components';
+import { Markdown } from '@redocly/theme/components/Markdown/Markdown';
+
+import { CodeGuideProvider } from '@portal/CodeGuide';
+
+import { CodeDemo } from './CodeDemo';
+
+export default function CodeGuide(props: React.PropsWithChildren<any>) {
+  const {
+    pageProps: { codeGuideFiles },
+    children,
+  } = props;
+
+  const initialState = {
+    codeGuideFiles,
+    highlightedLines: '',
+    activeCodeTab: codeGuideFiles?.[0]?.name || '',
+  };
+
+  return (
+    <CodeGuideProvider initialState={initialState}>
+      <Wrapper data-component-name="layouts/CodeGuide">
+        <Markdown>{children}</Markdown>
+        <div>
+          <StickyPosition>
+            <CodeDemo />
+          </StickyPosition>
+        </div>
+      </Wrapper>
+    </CodeGuideProvider>
+  );
+}
+
+const Wrapper = styled.div`
+  padding-left: 24px;
+  display: grid;
+  grid-template-columns: 40% 55%;
+  grid-column-gap: 45px;
+  height: 100%;
+`;
+
+const StickyPosition = styled.div`
+  position: sticky;
+  top: 50px;
+  left: 0;
+`;

package/src/mocks/CodeGuide/index.tsx

@@ -0,0 +1,79 @@
+import React from 'react';
+
+export const CodeGuideContext = React.createContext({
+  highlightedLines: '',
+  activeCodeTab: '',
+  activeDocsSection: '',
+  codeBlock: undefined,
+  codeGuideFiles: [] as CodeGuideFile[],
+  updateHighlightedLines: (_lines: string) => {},
+  setCurrentCodeSample: (_fileName: string) => {},
+  setActiveDocumentationSection: (_sectionId: string) => {},
+  setCodeNode: (_node: React.MutableRefObject<HTMLPreElement | null>) => {},
+});
+
+export type CodeGuideFile = { name: string; lang?: string; content: string };
+
+export interface CodeGuideProviderProps {
+  initialState: {
+    codeGuideFiles: CodeGuideFile[];
+    highlightedLines: string;
+    activeCodeTab: string;
+  };
+}
+
+export const CodeGuideProvider = ({
+  children,
+  initialState,
+}: React.PropsWithChildren<CodeGuideProviderProps>) => {
+  const contextValue = {
+    highlightedLines: initialState.highlightedLines,
+    activeCodeTab: initialState.activeCodeTab,
+    activeDocsSection: '',
+    codeBlock: undefined,
+    codeGuideFiles: [] as CodeGuideFile[],
+    updateHighlightedLines: (_lines: string) => {},
+    setCurrentCodeSample: (_fileName: string) => {},
+    setActiveDocumentationSection: (_sectionId: string) => {},
+    setCodeNode: (_node: React.MutableRefObject<HTMLPreElement | null>) => {},
+  };
+
+  return <CodeGuideContext.Provider value={contextValue}>{children}</CodeGuideContext.Provider>;
+};
+
+// @ts-ignore
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function useCodeGuideHighlightLines(highlightedLines: string) {}
+
+type CodeStepHandlersProps = {
+  nodeRef: React.RefObject<HTMLDivElement>;
+  bindTo: string;
+  context: typeof CodeGuideContext.Provider.prototype.value;
+};
+
+// @ts-ignore
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function useCodeStepHandlers({ nodeRef, bindTo, context }: CodeStepHandlersProps): {
+  onScroll: (codeBlock: HTMLPreElement | undefined) => void;
+  activateSection: (file: string, lines: string, codeBlock: HTMLPreElement | undefined) => void;
+} {
+  const onScroll = (codeBlock: HTMLPreElement | undefined) => {
+    if (nodeRef.current) {
+      const offsetTop = nodeRef.current.getBoundingClientRect().top;
+      if (offsetTop < 300 && offsetTop > 150) {
+        activateSection('', '', codeBlock);
+      }
+    }
+  };
+
+  // @ts-ignore
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const activateSection = (file: string, lines: string, codeBlock: HTMLPreElement | undefined) => {
+    codeBlock?.scrollTo(0, 0);
+  };
+
+  return {
+    onScroll,
+    activateSection,
+  };
+}