Skip to content

Commit

Permalink
feat: showcase and global safari admonition
Browse files Browse the repository at this point in the history
  • Loading branch information
kausko committed Aug 26, 2024
1 parent 246c576 commit bc7f956
Show file tree
Hide file tree
Showing 13 changed files with 113 additions and 8 deletions.
File renamed without changes.
14 changes: 13 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ const config: Config = {
position: 'left',
label: 'Docs',
},
{href: 'https://provenancewidgets.github.io/showcase/', label: 'Showcase', position: 'left'},
{
to: 'docs/showcase/',
label: 'Showcase',
position: 'left'
},
{
href: `https://github.com/ProvenanceWidgets/ProvenanceWidgets`,
label: 'GitHub',
Expand Down Expand Up @@ -134,6 +138,14 @@ const config: Config = {
theme: prismThemes.oneLight,
darkTheme: prismThemes.oceanicNext
},
colorMode: {
respectPrefersColorScheme: true,
},
announcementBar: {
content: '⚠️ ProvenanceWidgets is not yet fully compatible with Safari. We recommend using a chromium-based browser or Firefox for the best experience.',
backgroundColor: 'var(--ifm-color-danger-darker)',
textColor: 'white'
}
} satisfies Preset.ThemeConfig,

clientModules: [
Expand Down
18 changes: 18 additions & 0 deletions src/pages/docs/showcase.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.linkReset {
color: inherit;
}

.linkReset:hover {
color: inherit;
text-decoration: none;
transform: scale(1.01);
transition: transform 0.2s ease-in-out;
}

.titleOverride {
color: var(--ifm-link-color);
}

.paragraphReset {
text-decoration: none;
}
82 changes: 82 additions & 0 deletions src/pages/docs/showcase.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import Layout from "@theme/Layout"
import Heading from '@theme/Heading';
import Link from "@docusaurus/Link";
import styles from './showcase.module.css'
import clsx from "clsx";

const projects = [
{
title: 'Playground',
description: 'A playground to test out all widgets available in the library.',
link: 'playground'
},
{
title: 'Scented Widgets',
description: 'A showcase to replicate Scented Widgets for facilitating navigation in information spaces.',
link: 'scented-widgets'
},
{
title: 'Phosphor Objects',
description: 'A showcase to replicate Phosphor objects in a web environment by limiting the provenance to the last two interactions.',
link: 'phosphor-objects'
},
{
title: 'Data Distribution',
description: 'A showcase to visualize the data distribution of different attributes in a dataset using different widgets in the library.',
link: 'data-distribution'
},
{
title: 'Vega Integration',
description: 'A showcase to demonstrate the integrability of ProvenanceWidgets with Vega signals.',
link: 'vega-example'
},
{
title: 'Dynamic Query Widgets',
description: 'A showcase to replicate the dynamic query widgets for the homefinder application.',
link: 'dynamic-query-widgets-homefinder'
},
{
title: 'Widgets to Visualization Interaction',
description: 'A showcase to demonstrate the use of ProvenanceWidgets to interact with a visualization.',
link: 'widgets-to-vis-one-way'
},
{
title: 'Visualization to Widgets Interaction',
description: 'A showcase to demonstrate how the widgets can be updated by interacting with a visualization.',
link: 'vis-to-widgets-one-way'
}
]

const title = 'Showcase'
const description = 'Demonstrations of the ProvenanceWidgets library in action.'

export default function Showcase() {
return (
<Layout {...{ title, description }}>
<div className="container padding-top--md padding-bottom--lg">
<Heading as="h1" className="hero__title">
{title}
</Heading>
<p className="hero__subtitle">{description}</p>
<div className="grid">
{projects.map((project, i) => (
<div className="col-12 md:col-6 lg:col-3" key={i}>
<Link
className={clsx('card h-full', styles.linkReset)}
to={`https://provenancewidgets.github.io/showcase/#/${project.link}`}
>
<div className="card__image">
<img src={`/img/${project.link}.png`} alt={project.title} />
</div>
<div className="card__body">
<h4 className={styles.titleOverride}>{project.title}</h4>
<small className={styles.paragraphReset}>{project.description}</small>
</div>
</Link>
</div>
))}
</div>
</div>
</Layout>
)
}
7 changes: 0 additions & 7 deletions src/pages/markdown-page.md

This file was deleted.

Binary file added static/img/data-distribution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/dynamic-query-widgets-homefinder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/phosphor-objects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/playground.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/scented-widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/vega-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/vis-to-widgets-one-way.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/widgets-to-vis-one-way.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bc7f956

Please sign in to comment.