Skip to content

Commit

Permalink
feat(nx-dev): add deepdive callout component
Browse files Browse the repository at this point in the history
  • Loading branch information
juristr committed Aug 27, 2024
1 parent 61ecd4b commit daf5837
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 109 deletions.
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,14 @@ Your content goes here.
{% /callout %}
```

#### Disclosure
#### Deep Dives

A disclosure can be used for less important information that is initially collapsed.
These are special callouts that are collapsed with the intention of containing more deep-dive information about the topic which isn't required to understand right away.

```markdown
{% disclosure title="string" %}
Your content goes here.
{% /disclosure %}
{% callout type="deepdive" title="string" %}
Your deep-dive content goes here.
{% /callout %}
```

#### Cards
Expand Down
4 changes: 2 additions & 2 deletions docs/nx-cloud/concepts/reduce-waste.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ If we don't use the `nx affected` command in CI, no matter how our repo is struc

Note that the 50% chance of any project being modified is an arbitrary number. If we had picked a lower chance of being modified all the expected values would decrease as well. Every repository is different, but this illustrates that a flatter structure will help speed up your CI pipeline.

{% disclosure title="The Math Behind the Expected Number of Affected Projects" %}
{% callout title="The Math Behind the Expected Number of Affected Projects" type="deepdive" %}

**Definitions:**

Expand Down Expand Up @@ -290,7 +290,7 @@ Note that the 50% chance of any project being modified is an arbitrary number. I
**Expected Number of Affected Projects:**
ℙa(1) + ℙa(2) + ℙa(3) = 0.5 + 0.5 + 0.5 = 1.5

{% /disclosure %}
{% /callout %}

## Reduce Wasted Time with Remote Caching

Expand Down
4 changes: 2 additions & 2 deletions docs/nx-cloud/features/dynamic-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ distribute-on:
large-changeset: 10 linux-medium-js
```

{% callout type="note" title="How is the size of the PR determined?" %}
To determine the size of the PR, Nx Cloud calculates the ratio between the number of [affected projects](/ci/features/affected) and the total number of projects in the workspace. It then categorizes it as small, medium, or large.
{% callout type="deepdive" title="How is the size of the PR determined?" %}
To determine the size of the PR, Nx Cloud calculates the relationship between the number of [affected projects](/ci/features/affected) and the total number of projects in the workspace. It then assigns it to one of the three categories: small, medium, or large.
{% /callout %}

You can then reference it in your CI pipeline configuration:
Expand Down
4 changes: 0 additions & 4 deletions nx-dev/ui-markdoc/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ import { CallToAction } from './lib/tags/call-to-action.component';
import { callToAction } from './lib/tags/call-to-action.schema';
import { Card, Cards, LinkCard } from './lib/tags/cards.component';
import { card, cards, linkCard } from './lib/tags/cards.schema';
import { Disclosure } from './lib/tags/disclosure.component';
import { disclosure } from './lib/tags/disclosure.schema';
import { GithubRepository } from './lib/tags/github-repository.component';
import { githubRepository } from './lib/tags/github-repository.schema';
import { StackblitzButton } from './lib/tags/stackblitz-button.component';
Expand Down Expand Up @@ -78,7 +76,6 @@ export const getMarkdocCustomConfig = (
'call-to-action': callToAction,
card,
cards,
disclosure,
'link-card': linkCard,
'github-repository': githubRepository,
'stackblitz-button': stackblitzButton,
Expand Down Expand Up @@ -107,7 +104,6 @@ export const getMarkdocCustomConfig = (
CallToAction,
Card,
Cards,
Disclosure,
LinkCard,
CustomLink,
FenceWrapper,
Expand Down
87 changes: 66 additions & 21 deletions nx-dev/ui-markdoc/src/lib/tags/callout.component.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
'use client';

import React, { useState, useEffect } from 'react';
import cx from 'classnames';
import {
ChevronRightIcon,
ChevronDownIcon,
CheckCircleIcon,
ExclamationCircleIcon,
HandRaisedIcon,
InformationCircleIcon,
AcademicCapIcon,
} from '@heroicons/react/24/outline';
import cx from 'classnames';
import { ReactNode } from 'react';

type CalloutType = 'note' | 'warning' | 'check' | 'caution';
type CalloutType = 'note' | 'warning' | 'check' | 'caution' | 'deepdive';

const typeMap: Record<
CalloutType,
{
Expand All @@ -26,7 +32,7 @@ const typeMap: Record<
/>
),
backgroundColor: 'bg-slate-50 dark:bg-slate-800/40',
borderColor: 'ring-slate-100 dark:ring-slate-700',
borderColor: 'border-slate-200 dark:border-slate-700',
titleColor: 'text-slate-600 dark:text-slate-300',
textColor: 'text-slate-700 dark:text-slate-400',
},
Expand All @@ -38,7 +44,7 @@ const typeMap: Record<
/>
),
backgroundColor: 'bg-yellow-50 dark:bg-yellow-900/30',
borderColor: 'ring-yellow-100 dark:ring-yellow-900',
borderColor: 'border-yellow-200 dark:border-yellow-800',
titleColor: 'text-yellow-600 dark:text-yellow-400',
textColor: 'text-yellow-700 dark:text-yellow-600',
},
Expand All @@ -50,7 +56,7 @@ const typeMap: Record<
/>
),
backgroundColor: 'bg-green-50 dark:bg-green-900/30',
borderColor: 'ring-green-100 dark:ring-green-900',
borderColor: 'border-green-200 dark:border-green-800',
titleColor: 'text-green-600 dark:text-green-400',
textColor: 'text-green-700 dark:text-green-600',
},
Expand All @@ -59,43 +65,82 @@ const typeMap: Record<
<HandRaisedIcon className="h-5 w-5 text-red-500" aria-hidden="true" />
),
backgroundColor: 'bg-red-50 dark:bg-red-900/30',
borderColor: 'ring-red-100 dark:ring-red-900',
borderColor: 'border-red-200 dark:border-red-800',
titleColor: 'text-red-600 dark:text-red-400',
textColor: 'text-red-700 dark:text-red-600',
},
deepdive: {
icon: (
<AcademicCapIcon className="h-5 w-5 text-blue-500" aria-hidden="true" />
),
backgroundColor: 'bg-blue-50 dark:bg-blue-900/30',
borderColor: 'border-blue-200 dark:border-blue-800',
titleColor: 'text-white-600 dark:text-white-400',
textColor: 'text-white-700 dark:text-white-600',
},
};

export function Callout({
title,
type,
children,
defaultExpanded = false,
}: {
title: string;
type: CalloutType;
children: ReactNode;
defaultExpanded?: boolean;
}) {
const [isOpen, setIsOpen] = useState(type !== 'deepdive');
const ui = typeMap[type] || typeMap.note;
const isCollapsible = type === 'deepdive';

useEffect(() => {
if (isCollapsible) {
setIsOpen(defaultExpanded);
}
}, [defaultExpanded, isCollapsible]);

const toggleOpen = () => {
if (isCollapsible) {
setIsOpen(!isOpen);
}
};

// We use `<span>`s because we are inside `<p>`s
return (
<span
<div
className={cx(
'my-6 block rounded-md p-4 ring-1',
ui.backgroundColor,
ui.borderColor
'my-6 overflow-hidden rounded-md border',
ui.borderColor,
ui.backgroundColor
)}
>
<span className="flex">
<span className="flex-shrink-0">{ui.icon}</span>
<span className="ml-3">
<span className={cx('mt-0 block text-sm font-medium', ui.titleColor)}>
<div
onClick={toggleOpen}
className={cx(
'flex w-full items-center justify-between p-4',
'transition-colors duration-200 hover:bg-opacity-80',
{ 'cursor-pointer': isCollapsible }
)}
>
<span className="flex items-center">
<span className="flex-shrink-0">{ui.icon}</span>
<span className={cx('ml-3 text-sm font-medium', ui.titleColor)}>
{title}
</span>
<span className={cx('prose-sm mt-2 block', ui.textColor)}>
{children}
</span>
</span>
</span>
</span>
{isCollapsible &&
(isOpen ? (
<ChevronDownIcon className="h-5 w-5" />
) : (
<ChevronRightIcon className="h-5 w-5" />
))}
</div>
{isOpen && (
<div className="px-4 pb-4 pt-0">
<span className={cx('prose-sm block', ui.textColor)}>{children}</span>
</div>
)}
</div>
);
}
61 changes: 0 additions & 61 deletions nx-dev/ui-markdoc/src/lib/tags/disclosure.component.tsx

This file was deleted.

14 changes: 0 additions & 14 deletions nx-dev/ui-markdoc/src/lib/tags/disclosure.schema.ts

This file was deleted.

0 comments on commit daf5837

Please sign in to comment.