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

[Roadmap] Custom version name functionality #5974

Merged
merged 12 commits into from
Aug 28, 2024
Merged

[Roadmap] Custom version name functionality #5974

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
506fb82
get customDisplay showing on selected version
JKarlavige Aug 19, 2024
bdd3fc5
show custom display name if set for desktop nav
JKarlavige Aug 20, 2024
4da2488
add data attribute to store version rather than storing in the nav text
JKarlavige Aug 20, 2024
59237ea
Merge branch 'current' into custom-version-name
JKarlavige Aug 26, 2024
0d81104
show custom display name for label attr on mobile
JKarlavige Aug 26, 2024
ab65fe1
cleanup consoles and comments
JKarlavige Aug 26, 2024
4c8cfbd
Merge branch 'current' into custom-version-name
JKarlavige Aug 27, 2024
9c267d8
add comment for versionValue var
JKarlavige Aug 27, 2024
eb15af2
Merge branch 'current' into custom-version-name
JKarlavige Aug 27, 2024
0cd0bef
remove demo customDisplay property
JKarlavige Aug 27, 2024
907a901
add type defs to better document available options in dbt-versions file
JKarlavige Aug 27, 2024
3532558
Merge branch 'current' into custom-version-name
JKarlavige Aug 28, 2024
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
3 changes: 2 additions & 1 deletion website/dbt-versions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ exports.versions = [
{
version: "1.9",
isPrerelease: true,
customDisplay: "dbt Cloud"
},
{
version: "1.8",
Expand Down Expand Up @@ -169,4 +170,4 @@ exports.versionedCategories = [
"category": "Build your metrics",
"firstVersion": "1.6",
}
]
]
10 changes: 6 additions & 4 deletions website/src/stores/VersionContext.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ export const VersionContextProvider = ({ value = "", children }) => {
const updateVersion = (e) => {
if(!e.target)
return

const vRegex = /(?:v)?(\d+(\.\d+)*)/ // Regex that will parse out the version number, even if there is/isn't a 'v' in front of version number and a '(Beta)' afterwards.
const versionValue = e.target.text.match(vRegex)[1]

// Get selected version value from `dbt-version` data attribute
const versionValue = e.target?.dataset?.dbtVersion

versionValue &&
setVersion(versionValue)
window.localStorage.setItem('dbtVersion', versionValue)
Expand All @@ -66,9 +66,11 @@ export const VersionContextProvider = ({ value = "", children }) => {

// Determine isPrerelease status + End of Life date for current version
const currentVersion = versions.find(ver => ver.version === version)
if(currentVersion)
if(currentVersion) {
context.EOLDate = currentVersion.EOLDate
context.isPrerelease = currentVersion?.isPrerelease
context.customDisplay = currentVersion?.customDisplay;
}

// Get latest stable release
const latestStableRelease = versions.find(ver => !ver?.isPrerelease)
Expand Down
152 changes: 90 additions & 62 deletions website/src/theme/NavbarItem/DropdownNavbarItem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,74 +78,89 @@ function DropdownNavbarItemDesktop({
useEffect(() => {
setShowVersionDropdown(true)
}, [showVersionDropdown])

return (
<div
ref={dropdownRef}
className={clsx('navbar__item', 'dropdown', 'dropdown--hoverable', {
'dropdown--right': position === 'right',
'dropdown--show': showDropdown,
'dropdown--version--hide': !showVersionDropdown,
})}>
className={clsx("navbar__item", "dropdown", "dropdown--hoverable", {
"dropdown--right": position === "right",
"dropdown--show": showDropdown,
"dropdown--version--hide": !showVersionDropdown,
})}
>
<NavbarNavLink
aria-haspopup="true"
aria-expanded={showDropdown}
role="button"
href={props.to ? undefined : '#'}
className={clsx('navbar__link', className)}
href={props.to ? undefined : "#"}
className={clsx("navbar__link", className)}
{...props}
onClick={props.to ? undefined : (e) => e.preventDefault()}
onKeyDown={(e) => {
if (e.key === 'Enter') {
if (e.key === "Enter") {
e.preventDefault();
setShowDropdown(!showDropdown);
}
}}
label={className === "nav-versioning" ? `v${versionContext.version} ${versionContext?.isPrerelease ? "(Beta)" : ""}` : props.children ?? props.label}
label={
className === "nav-versioning"
? `${versionContext?.customDisplay ? `${versionContext.customDisplay}` : `v${versionContext.version} ${versionContext?.isPrerelease ? "(Beta)" : ""}`}`
: props.children ?? props.label
}
>
{props.children ?? props.label}
</NavbarNavLink>
<ul className="dropdown__menu">
{items.map((childItemProps, i) => (
<React.Fragment key={i}>
{className === "nav-versioning" ? (
<li>
<a
className='dropdown__link nav-versioning-dropdown__link'
onClick={(e) => {
handleVersionMenuClick()
versionContext.updateVersion(e)
}
}
>{childItemProps.label}
{versions.find((version) => (childItemProps.label == version.version))?.isPrerelease && " (Beta)"}</a>
</li>
) : (
<NavbarItem
isDropdownItem
onKeyDown={(e) => {
if (i === items.length - 1 && e.key === 'Tab') {
e.preventDefault();
setShowDropdown(false);
const nextNavbarItem = dropdownRef.current.nextElementSibling;
if (nextNavbarItem) {
const targetItem =
nextNavbarItem instanceof HTMLAnchorElement
? nextNavbarItem
: // Next item is another dropdown; focus on the inner
// anchor element instead so there's outline
nextNavbarItem.querySelector('a');
targetItem.focus();
{items.map((childItemProps, i) => {
const thisVersion = versions.find(
(version) => childItemProps.label == version.version
);
const versionDisplay = thisVersion?.customDisplay ? thisVersion.customDisplay : `${childItemProps.label} ${thisVersion?.isPrerelease ? " (Beta)" : ""}`;

return (
<React.Fragment key={i}>
{className === "nav-versioning" ? (
<li>
<a
className="dropdown__link nav-versioning-dropdown__link"
data-dbt-version={childItemProps.label}
onClick={(e) => {
handleVersionMenuClick();
versionContext.updateVersion(e);
}}
>
{versionDisplay}
</a>
</li>
) : (
<NavbarItem
isDropdownItem
onKeyDown={(e) => {
if (i === items.length - 1 && e.key === "Tab") {
e.preventDefault();
setShowDropdown(false);
const nextNavbarItem =
dropdownRef.current.nextElementSibling;
if (nextNavbarItem) {
const targetItem =
nextNavbarItem instanceof HTMLAnchorElement
? nextNavbarItem
: // Next item is another dropdown; focus on the inner
// anchor element instead so there's outline
nextNavbarItem.querySelector("a");
targetItem.focus();
}
}
}
}}
activeClassName="dropdown__link--active"
{...childItemProps}
key={i}
/>
)}
</React.Fragment>
))}
}}
activeClassName="dropdown__link--active"
{...childItemProps}
key={i}
/>
)}
</React.Fragment>
);
}
)}
</ul>
</div>
);
Expand All @@ -171,42 +186,55 @@ function DropdownNavbarItemMobile({
}, [localPathname, containsActive, setCollapsed]);
return (
<li
className={clsx('menu__list-item', {
'menu__list-item--collapsed': collapsed,
})}>
className={clsx("menu__list-item", {
"menu__list-item--collapsed": collapsed,
})}
>
<NavbarNavLink
role="button"
className={clsx(
'menu__link menu__link--sublist menu__link--sublist-caret',
className,
"menu__link menu__link--sublist menu__link--sublist-caret",
className
)}
{...props}
onClick={(e) => {
e.preventDefault();
toggleCollapsed();
}}
label={className === "nav-versioning" ? `v${versionContext.version} ${versionContext.isPrerelease ? "(Beta)" : ""}` : props.children ?? props.label}
label={
className === "nav-versioning"
? `${versionContext?.customDisplay ? `${versionContext.customDisplay}` : `v${versionContext.version} ${versionContext?.isPrerelease ? "(Beta)" : ""}`}`
: props.children ?? props.label
}
>
{props.children ?? props.label}
</NavbarNavLink>
<Collapsible lazy as="ul" className="menu__list" collapsed={collapsed}>
{items.map((childItemProps, i) => {
childItemProps.label = versions.find((version) => (childItemProps.label == version.version))?.isPrerelease ? `${childItemProps.label} (Beta)` : `${childItemProps.label}`;
const thisVersion = versions.find(
(version) => childItemProps.label == version.version
);
const versionDisplay = thisVersion?.customDisplay
? thisVersion.customDisplay
: `${childItemProps.label} ${thisVersion?.isPrerelease ? " (Beta)" : ""}`;

return (
<NavbarItem
mobile
isDropdownItem
onClick={className === "nav-versioning"
? (e) => versionContext.updateVersion(e)
: onClick
data-dbt-version={childItemProps.label}
onClick={
className === "nav-versioning"
? (e) => versionContext.updateVersion(e)
: onClick
}
activeClassName="menu__link--active"
{...childItemProps}
label={versionDisplay}
key={i}
/>
)
}
)}
);
})}
</Collapsible>
</li>
);
Expand Down
Loading