forked from twentyhq/twenty
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modifications user guide (twentyhq#5207)
- Modified layout and responsive - Added remaining user guide cards - Added new table of content: https://github.com/twentyhq/twenty/assets/102751374/007118e5-60f2-4572-90cf-339c134f23c4 -Added fade-in: https://github.com/twentyhq/twenty/assets/102751374/0669c06d-3eab-484c-a5b5-3857c68f42b5 --------- Co-authored-by: Ady Beraud <[email protected]>
- Loading branch information
1 parent
c67d1ea
commit a4b2321
Showing
22 changed files
with
479 additions
and
284 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
packages/twenty-website/src/app/_components/user-guide/TableContent.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| 'use client'; | ||
| import { useEffect, useState } from 'react'; | ||
| import styled from '@emotion/styled'; | ||
| import { usePathname } from 'next/navigation'; | ||
|
|
||
| import mq from '@/app/_components/ui/theme/mq'; | ||
| import { Theme } from '@/app/_components/ui/theme/theme'; | ||
| import { useHeadsObserver } from '@/app/user-guide/hooks/useHeadsObserver'; | ||
|
|
||
| const StyledContainer = styled.div` | ||
| ${mq({ | ||
| display: ['none', 'none', 'flex'], | ||
| flexDirection: 'column', | ||
| background: `${Theme.background.secondary}`, | ||
| borderLeft: `1px solid ${Theme.background.transparent.medium}`, | ||
| borderBottom: `1px solid ${Theme.background.transparent.medium}`, | ||
| padding: `0px ${Theme.spacing(6)}`, | ||
| })}; | ||
| width: 300px; | ||
| min-width: 300px; | ||
| `; | ||
|
|
||
| const StyledNav = styled.nav` | ||
| width: 220px; | ||
| min-width: 220px; | ||
| align-self: flex-start; | ||
| padding: 32px 0px; | ||
| position: -webkit-sticky; | ||
| position: sticky; | ||
| top: 70px; | ||
| max-height: calc(100vh - 70px); | ||
| overflow: auto; | ||
| `; | ||
|
|
||
| const StyledUnorderedList = styled.ul` | ||
| list-style-type: none; | ||
| padding: 0; | ||
| `; | ||
|
|
||
| const StyledList = styled.li` | ||
| margin: 12px 0px; | ||
| `; | ||
|
|
||
| const StyledLink = styled.a` | ||
| text-decoration: none; | ||
| font-size: 12px; | ||
| font-family: var(--font-inter); | ||
| color: ${Theme.text.color.tertiary}; | ||
| &:hover { | ||
| color: ${Theme.text.color.secondary}; | ||
| } | ||
| &:active { | ||
| color: ${Theme.text.color.primary}; | ||
| font-weight: 500 !important; | ||
| } | ||
| `; | ||
|
|
||
| const StyledHeadingText = styled.div` | ||
| font-size: ${Theme.font.size.sm}; | ||
| color: ${Theme.text.color.quarternary}; | ||
| margin-bottom: 20px; | ||
| `; | ||
|
|
||
| const getStyledHeading = (level: number) => { | ||
| switch (level) { | ||
| case 3: | ||
| return { | ||
| marginLeft: 10, | ||
| }; | ||
| case 4: | ||
| return { | ||
| marginLeft: 20, | ||
| }; | ||
| case 5: | ||
| return { | ||
| marginLeft: 30, | ||
| }; | ||
| default: | ||
| return undefined; | ||
| } | ||
| }; | ||
|
|
||
| interface HeadingType { | ||
| id: string; | ||
| elem: HTMLElement; | ||
| className: string; | ||
| text: string; | ||
| level: number; | ||
| } | ||
|
|
||
| const UserGuideTableContents = () => { | ||
| const [headings, setHeadings] = useState<HeadingType[]>([]); | ||
| const pathname = usePathname(); | ||
| const { activeText } = useHeadsObserver(pathname); | ||
|
|
||
| useEffect(() => { | ||
| const nodes: HTMLElement[] = Array.from( | ||
| document.querySelectorAll('h2, h3, h4, h5'), | ||
| ); | ||
| const elements: HeadingType[] = nodes.map( | ||
| (elem): HeadingType => ({ | ||
| id: elem.id, | ||
| elem: elem, | ||
| className: elem.className, | ||
| text: elem.innerText, | ||
| level: Number(elem.nodeName.charAt(1)), | ||
| }), | ||
| ); | ||
|
|
||
| setHeadings(elements); | ||
| }, [pathname]); | ||
|
|
||
| return ( | ||
| <StyledContainer> | ||
| <StyledNav> | ||
| <StyledHeadingText>Table of Content</StyledHeadingText> | ||
| <StyledUnorderedList> | ||
| {headings.map((heading) => ( | ||
| <StyledList | ||
| key={heading.text} | ||
| style={getStyledHeading(heading.level)} | ||
| > | ||
| <StyledLink | ||
| href={`#${heading.text}`} | ||
| onClick={(e) => { | ||
| e.preventDefault(); | ||
| const yOffset = -70; | ||
| const y = | ||
| heading.elem.getBoundingClientRect().top + | ||
| window.scrollY + | ||
| yOffset; | ||
|
|
||
| window.scrollTo({ top: y, behavior: 'smooth' }); | ||
| }} | ||
| style={{ | ||
| fontWeight: activeText === heading.text ? 'bold' : 'normal', | ||
| }} | ||
| > | ||
| {heading.text} | ||
| </StyledLink> | ||
| </StyledList> | ||
| ))} | ||
| </StyledUnorderedList> | ||
| </StyledNav> | ||
| </StyledContainer> | ||
| ); | ||
| }; | ||
|
|
||
| export default UserGuideTableContents; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.