fix(Editor): add empty role picker help page and link

This commit is contained in:
41666 2021-07-09 04:30:34 -05:00
parent 30b9ea3a59
commit d8cdc1c62a
5 changed files with 152 additions and 25 deletions

View file

@ -1,6 +1,7 @@
import { Role } from '@roleypoly/design-system/atoms/role';
import { Space } from '@roleypoly/design-system/atoms/space';
import { TextInputWithIcon } from '@roleypoly/design-system/atoms/text-input';
import { Link } from '@roleypoly/design-system/atoms/typography';
import { Role as RoleType } from '@roleypoly/types';
import Fuse from 'fuse.js';
import * as React from 'react';
@ -32,21 +33,36 @@ export const RoleSearch = (props: Props) => {
<div>
<TextInputWithIcon
icon={<GoSearch />}
placeholder={props.placeholder || 'Search or drag a role...'}
placeholder={props.placeholder || 'Search for a role...'}
value={props.searchTerm}
onChange={(x) => props.onSearchUpdate(x.target.value)}
/>
<Space />
{results.map((resultRole, idx) => (
<RoleInliner key={idx}>
<Role
selected={false}
role={resultRole.item}
onClick={handleClick(resultRole.item)}
key={`${idx}role`}
/>
</RoleInliner>
))}
{props.roles.length > 0 ? (
results.length > 0 ? (
results.map((resultRole, idx) => (
<RoleInliner key={idx}>
<Role
selected={false}
role={resultRole.item}
onClick={handleClick(resultRole.item)}
key={`${idx}role`}
/>
</RoleInliner>
))
) : (
<i>
No roles could be found. Try a different search term.
<br />
</i>
)
) : (
<i>
Roleypoly can't see any more roles.
<br />
<Link href="/help/why-no-roles">Learn why</Link>
</i>
)}
</div>
);
};

View file

@ -1,6 +1,8 @@
import { numberToChroma, palette } from '@roleypoly/design-system/atoms/colors';
import { Role } from '@roleypoly/types';
import styled, { css } from 'styled-components';
import chroma from 'chroma-js';
import { GoCheck, GoQuestion, GoX } from 'react-icons/go';
import styled, { css, keyframes } from 'styled-components';
export const DiscordBase = styled.div`
background-color: ${palette.discord100};
@ -17,9 +19,26 @@ const hover = (roleColor: string) => css`
cursor: pointer;
`;
const isBadFlash = keyframes`
/* stylelint-disable function-name-case, function-whitespace-after */
0%, 100% {
box-shadow: 0 0 8px ${chroma(palette.red400).alpha(0.5).css()}
}
66% {
box-shadow: 0 0 2px ${chroma(palette.red200).alpha(0.5).css()}
}
33% {
box-shadow: 0 0 2px ${chroma(palette.red400).alpha(0.5).css()}
}
`;
export const DiscordRole = styled.div<{
discordRole: Role;
isRoleypoly: boolean;
isGood: boolean;
}>`
/* stylelint-disable function-name-case, function-whitespace-after */
@ -35,4 +54,29 @@ export const DiscordRole = styled.div<{
${(props) =>
props.isRoleypoly && hover(numberToChroma(props.discordRole.color).alpha(0.5).css())}
${(props) =>
!props.isGood &&
props.isRoleypoly &&
css`
animation: ${isBadFlash} 0.5s 10s ease-in-out both;
`}
`;
const bumpDown = css`
position: relative;
top: 0.1em;
margin-right: 0.25em;
`;
export const Dont = styled(GoX)`
${bumpDown}
color: ${palette.red400};
`;
export const Do = styled(GoCheck)`
${bumpDown}
color: ${palette.green400};
`;
export const Why = styled(GoQuestion)`
${bumpDown}
color: ${palette.discord400};
`;

View file

@ -1,12 +1,17 @@
import { palette } from '@roleypoly/design-system/atoms/colors';
import { HalfsiesContainer, HalfsiesItem } from '@roleypoly/design-system/atoms/halfsies';
import { SparkleOverlay } from '@roleypoly/design-system/atoms/sparkle';
import { Toggle } from '@roleypoly/design-system/atoms/toggle';
import {
AmbientLarge,
LargeText,
SmallTitle,
} from '@roleypoly/design-system/atoms/typography';
import { Role } from '@roleypoly/types';
import { demoData } from '@roleypoly/types/demoData';
import chroma from 'chroma-js';
import * as React from 'react';
import { FaCheck, FaTimes } from 'react-icons/fa';
import { DiscordBase, DiscordRole } from './WhyNoRoles.styled';
import { DiscordBase, DiscordRole, Do, Dont, Why } from './WhyNoRoles.styled';
const adminRoles: Role[] = [
{
@ -60,7 +65,11 @@ const Example = (props: { roles: Role[]; isGood: boolean }) => (
<DiscordBase>
{props.roles.map((r) => (
<MaybeWithOverlay withOverlay={props.isGood && r.name === 'Roleypoly'}>
<DiscordRole discordRole={r} isRoleypoly={r.name === 'Roleypoly'}>
<DiscordRole
discordRole={r}
isRoleypoly={r.name === 'Roleypoly'}
isGood={props.isGood}
>
{r.name}
</DiscordRole>
</MaybeWithOverlay>
@ -70,14 +79,50 @@ const Example = (props: { roles: Role[]; isGood: boolean }) => (
);
export const WhyNoRoles = () => (
<HalfsiesContainer>
<HalfsiesItem>
<FaCheck /> Good
<Example isGood roles={goodRoles} />
</HalfsiesItem>
<HalfsiesItem>
<FaTimes /> Baddd
<Example isGood={false} roles={badRoles} />
</HalfsiesItem>
</HalfsiesContainer>
<div>
<p>
<SmallTitle>Why can't I see my roles?</SmallTitle>
</p>
<HalfsiesContainer>
<HalfsiesItem>
<Do />
<b>DO:</b> Roleypoly is above the other roles
<Example isGood roles={goodRoles} />
</HalfsiesItem>
<HalfsiesItem>
<Dont />
<b>DON'T:</b> Roleypoly is below the other roles
<Example isGood={false} roles={badRoles} />
</HalfsiesItem>
</HalfsiesContainer>
<AmbientLarge>
<Why />
{' '}
Discord doesn't let members/bots with "manage roles" permissions assign roles above
their highest role.
</AmbientLarge>
<p>
<LargeText>Other tips:</LargeText>
</p>
<p>
<Do />
<b>DO:</b> Roles have no elevated permissions.
<Toggle state={false}>Administrator</Toggle>
<Toggle state={false}>Manage Roles</Toggle>
<br />
<Dont />
<b>DON'T:</b> Roles cannot have Administrator or Manage Roles permissions.
<Toggle state={true}>Administrator</Toggle>
<Toggle state={true}>Manage Roles</Toggle>
<AmbientLarge>
<Why />
{' '}
These permissions give access to the Roleypoly editor and Discord tools, which can
open your server up to vandalism.
</AmbientLarge>
</p>
</div>
);

View file

@ -6,6 +6,7 @@ import ErrorPage from '../pages/error';
import LandingPage from '../pages/landing';
import PickerPage from '../pages/picker';
const WhyNoRoles = React.lazy(() => import('../pages/help/why-no-roles'));
const ServersPage = React.lazy(() => import('../pages/servers'));
const EditorPage = React.lazy(() => import('../pages/editor'));
@ -50,6 +51,8 @@ export const AppRouter = () => {
<RouteWrapper component={DevToolsSetApi} path="/x/dev-tools/set-api" />
<RouteWrapper component={DevToolsSessionDebug} path="/x/dev-tools/session-debug" />
<RouteWrapper component={WhyNoRoles} path="/help/why-no-roles" />
<RouteWrapper component={ErrorPage} default identity={404} />
</Router>
);

View file

@ -0,0 +1,19 @@
import { WhyNoRoles } from '@roleypoly/design-system/organisms/help-why-no-roles';
import { HelpPageTemplate } from '@roleypoly/design-system/templates/help-page';
import { useAppShellProps } from '../../contexts/app-shell/AppShellContext';
import { Title } from '../../utils/metaTitle';
const WhyNoRolesPage = () => {
const appShellProps = useAppShellProps();
return (
<>
<Title title="Why can't I see my roles? - Roleypoly Help" />
<HelpPageTemplate {...appShellProps}>
<WhyNoRoles />
</HelpPageTemplate>
</>
);
};
export default WhyNoRolesPage;