fix(striker-ui): relocate input help messages, reorder inputs

main
Tsu-ba-me 2 years ago
parent c981c286b1
commit 7abca9b508
  1. 240
      striker-ui/components/GeneralInitForm.tsx

@ -1,9 +1,17 @@
import { Box as MUIBox } from '@mui/material'; import { Grid as MUIGrid } from '@mui/material';
import { forwardRef, useImperativeHandle, useRef, useState } from 'react'; import {
forwardRef,
ReactNode,
useCallback,
useImperativeHandle,
useRef,
useState,
} from 'react';
import FlexBox from './FlexBox'; import FlexBox from './FlexBox';
import InputWithRef, { InputForwardedRefContent } from './InputWithRef'; import InputWithRef, { InputForwardedRefContent } from './InputWithRef';
import isEmpty from '../lib/isEmpty'; import isEmpty from '../lib/isEmpty';
import MessageBox from './MessageBox';
import OutlinedInputWithLabel, { import OutlinedInputWithLabel, {
OutlinedInputWithLabelProps, OutlinedInputWithLabelProps,
} from './OutlinedInputWithLabel'; } from './OutlinedInputWithLabel';
@ -12,6 +20,7 @@ import SuggestButton from './SuggestButton';
type GeneralInitFormForwardRefContent = { type GeneralInitFormForwardRefContent = {
get?: () => { get?: () => {
adminPassword?: string;
organizationName?: string; organizationName?: string;
organizationPrefix?: string; organizationPrefix?: string;
domainName?: string; domainName?: string;
@ -66,6 +75,7 @@ const buildHostName = ({
const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>( const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
(generalInitFormProps, ref) => { (generalInitFormProps, ref) => {
const [helpMessage, setHelpText] = useState<ReactNode | undefined>();
const [ const [
isShowOrganizationPrefixSuggest, isShowOrganizationPrefixSuggest,
setIsShowOrganizationPrefixSuggest, setIsShowOrganizationPrefixSuggest,
@ -73,6 +83,12 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
const [isShowHostNameSuggest, setIsShowHostNameSuggest] = const [isShowHostNameSuggest, setIsShowHostNameSuggest] =
useState<boolean>(false); useState<boolean>(false);
const adminPasswordInputRef = useRef<InputForwardedRefContent<'string'>>(
{},
);
const confirmAdminPasswordInputRef = useRef<
InputForwardedRefContent<'string'>
>({});
const organizationNameInputRef = useRef<InputForwardedRefContent<'string'>>( const organizationNameInputRef = useRef<InputForwardedRefContent<'string'>>(
{}, {},
); );
@ -83,8 +99,11 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
const hostNumberInputRef = useRef<InputForwardedRefContent<'number'>>({}); const hostNumberInputRef = useRef<InputForwardedRefContent<'number'>>({});
const hostNameInputRef = useRef<InputForwardedRefContent<'string'>>({}); const hostNameInputRef = useRef<InputForwardedRefContent<'string'>>({});
const populateOrganizationPrefixInput = ({ const populateOrganizationPrefixInput = useCallback(
organizationName = organizationNameInputRef.current.getValue?.call(null), ({
organizationName = organizationNameInputRef.current.getValue?.call(
null,
),
} = {}) => { } = {}) => {
const organizationPrefix = buildOrganizationPrefix(organizationName); const organizationPrefix = buildOrganizationPrefix(organizationName);
@ -94,8 +113,11 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
); );
return organizationPrefix; return organizationPrefix;
}; },
const populateHostNameInput = ({ [],
);
const populateHostNameInput = useCallback(
({
organizationPrefix = organizationPrefixInputRef.current.getValue?.call( organizationPrefix = organizationPrefixInputRef.current.getValue?.call(
null, null,
), ),
@ -111,12 +133,18 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
hostNameInputRef.current.setValue?.call(null, hostName); hostNameInputRef.current.setValue?.call(null, hostName);
return hostName; return hostName;
}; },
const isOrganizationPrefixPrereqFilled = () => [],
);
const isOrganizationPrefixPrereqFilled = useCallback(
() =>
isEmpty([organizationNameInputRef.current.getValue?.call(null)], { isEmpty([organizationNameInputRef.current.getValue?.call(null)], {
not: true, not: true,
}); }),
const isHostNamePrereqFilled = () => [],
);
const isHostNamePrereqFilled = useCallback(
() =>
isEmpty( isEmpty(
[ [
organizationPrefixInputRef.current.getValue?.call(null), organizationPrefixInputRef.current.getValue?.call(null),
@ -126,9 +154,11 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
{ {
not: true, not: true,
}, },
),
[],
); );
const populateOrganizationPrefixInputOnBlur: OutlinedInputWithLabelOnBlur = const populateOrganizationPrefixInputOnBlur: OutlinedInputWithLabelOnBlur =
() => { useCallback(() => {
if (organizationPrefixInputRef.current.getIsChangedByUser?.call(null)) { if (organizationPrefixInputRef.current.getIsChangedByUser?.call(null)) {
setIsShowOrganizationPrefixSuggest( setIsShowOrganizationPrefixSuggest(
isOrganizationPrefixPrereqFilled(), isOrganizationPrefixPrereqFilled(),
@ -136,27 +166,34 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
} else { } else {
populateOrganizationPrefixInput(); populateOrganizationPrefixInput();
} }
}; }, [isOrganizationPrefixPrereqFilled, populateOrganizationPrefixInput]);
const populateHostNameInputOnBlur: OutlinedInputWithLabelOnBlur = () => { const populateHostNameInputOnBlur: OutlinedInputWithLabelOnBlur =
useCallback(() => {
if (hostNameInputRef.current.getIsChangedByUser?.call(null)) { if (hostNameInputRef.current.getIsChangedByUser?.call(null)) {
setIsShowHostNameSuggest(isHostNamePrereqFilled()); setIsShowHostNameSuggest(isHostNamePrereqFilled());
} else { } else {
populateHostNameInput(); populateHostNameInput();
} }
}; }, [isHostNamePrereqFilled, populateHostNameInput]);
const handleOrganizationPrefixSuggest = () => { const handleOrganizationPrefixSuggest = useCallback(() => {
const organizationPrefix = populateOrganizationPrefixInput(); const organizationPrefix = populateOrganizationPrefixInput();
if (!hostNameInputRef.current.getIsChangedByUser?.call(null)) { if (!hostNameInputRef.current.getIsChangedByUser?.call(null)) {
populateHostNameInput({ organizationPrefix }); populateHostNameInput({ organizationPrefix });
} }
}; }, [populateHostNameInput, populateOrganizationPrefixInput]);
const handlerHostNameSuggest = () => { const handlerHostNameSuggest = useCallback(() => {
populateHostNameInput(); populateHostNameInput();
}; }, [populateHostNameInput]);
const buildHelpMessage = useCallback(
(text: string) => (previous?: string) =>
previous === text ? undefined : text,
[],
);
useImperativeHandle(ref, () => ({ useImperativeHandle(ref, () => ({
get: () => ({ get: () => ({
adminPassword: adminPasswordInputRef.current.getValue?.call(null),
organizationName: organizationNameInputRef.current.getValue?.call(null), organizationName: organizationNameInputRef.current.getValue?.call(null),
organizationPrefix: organizationPrefix:
organizationPrefixInputRef.current.getValue?.call(null), organizationPrefixInputRef.current.getValue?.call(null),
@ -167,44 +204,40 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
})); }));
return ( return (
<MUIBox <FlexBox>
sx={{ <MUIGrid columns={{ xs: 1, sm: 2, md: 3 }} container spacing="1em">
display: 'flex', <MUIGrid item xs={1}>
flexDirection: { xs: 'column', sm: 'row' },
'& > *': {
flexBasis: '50%',
},
'& > :not(:first-child)': {
marginLeft: { xs: 0, sm: '1em' },
marginTop: { xs: '1em', sm: 0 },
},
}}
>
<FlexBox> <FlexBox>
<InputWithRef <InputWithRef
input={ input={
<OutlinedInputWithLabel <OutlinedInputWithLabel
helpMessageBoxProps={{
text: 'Name of the organization that maintains this Anvil! system. You can enter anything that makes sense to you.',
}}
id="striker-init-general-organization-name" id="striker-init-general-organization-name"
inputProps={{ inputProps={{
onBlur: populateOrganizationPrefixInputOnBlur, onBlur: populateOrganizationPrefixInputOnBlur,
}} }}
label="Organization name" label="Organization name"
onHelp={() => {
setHelpText(
buildHelpMessage(
'Name of the organization that maintains this Anvil! system. You can enter anything that makes sense to you.',
),
);
}}
/> />
} }
ref={organizationNameInputRef} ref={organizationNameInputRef}
/> />
<FlexBox row> <FlexBox
row
sx={{
'& > *': {
flexBasis: '50%',
},
}}
>
<InputWithRef <InputWithRef
input={ input={
<OutlinedInputWithLabel <OutlinedInputWithLabel
helpMessageBoxProps={{
text: "Alphanumberic short-form of the organization name. It's used as the prefix for host names.",
}}
id="striker-init-general-organization-prefix" id="striker-init-general-organization-prefix"
inputProps={{ inputProps={{
endAdornment: ( endAdornment: (
@ -215,13 +248,8 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
), ),
inputProps: { inputProps: {
maxLength: MAX_ORGANIZATION_PREFIX_LENGTH, maxLength: MAX_ORGANIZATION_PREFIX_LENGTH,
style: { width: '2.5em' },
}, },
onBlur: populateHostNameInputOnBlur, onBlur: populateHostNameInputOnBlur,
sx: {
minWidth: 'min-content',
width: 'fit-content',
},
}} }}
label="Prefix" label="Prefix"
onChange={() => { onChange={() => {
@ -229,6 +257,13 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
isOrganizationPrefixPrereqFilled(), isOrganizationPrefixPrereqFilled(),
); );
}} }}
onHelp={() => {
setHelpText(
buildHelpMessage(
"Alphanumberic short-form of the organization name. It's used as the prefix for host names.",
),
);
}}
/> />
} }
ref={organizationPrefixInputRef} ref={organizationPrefixInputRef}
@ -236,18 +271,21 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
<InputWithRef <InputWithRef
input={ input={
<OutlinedInputWithLabel <OutlinedInputWithLabel
helpMessageBoxProps={{
text: "Number or count of this striker; this should be '1' for the first striker, '2' for the second striker, and such.",
}}
id="striker-init-general-host-number" id="striker-init-general-host-number"
inputProps={{ inputProps={{
inputProps: { maxLength: MAX_HOST_NUMBER_LENGTH }, inputProps: {
onBlur: populateHostNameInputOnBlur, maxLength: MAX_HOST_NUMBER_LENGTH,
sx: {
width: '6em',
}, },
onBlur: populateHostNameInputOnBlur,
}} }}
label="Host #" label="Host #"
onHelp={() => {
setHelpText(
buildHelpMessage(
"Number or count of this striker; this should be '1' for the first striker, '2' for the second striker, and such.",
),
);
}}
/> />
} }
ref={hostNumberInputRef} ref={hostNumberInputRef}
@ -255,21 +293,24 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
/> />
</FlexBox> </FlexBox>
</FlexBox> </FlexBox>
</MUIGrid>
<MUIGrid item xs={1}>
<FlexBox> <FlexBox>
<InputWithRef <InputWithRef
input={ input={
<OutlinedInputWithLabel <OutlinedInputWithLabel
helpMessageBoxProps={{
text: "Domain name for this striker. It's also the default domain used when creating new install manifests.",
}}
id="striker-init-general-domain-name" id="striker-init-general-domain-name"
inputProps={{ inputProps={{
onBlur: populateHostNameInputOnBlur, onBlur: populateHostNameInputOnBlur,
sx: {
minWidth: { sm: '16em' },
},
}} }}
label="Domain name" label="Domain name"
onHelp={() => {
setHelpText(
buildHelpMessage(
"Domain name for this striker. It's also the default domain used when creating new install manifests.",
),
);
}}
/> />
} }
ref={domainNameInputRef} ref={domainNameInputRef}
@ -278,9 +319,6 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
<InputWithRef <InputWithRef
input={ input={
<OutlinedInputWithLabel <OutlinedInputWithLabel
helpMessageBoxProps={{
text: "Host name for this striker. It's usually a good idea to use the auto-generated value.",
}}
id="striker-init-general-host-name" id="striker-init-general-host-name"
inputProps={{ inputProps={{
endAdornment: ( endAdornment: (
@ -289,25 +327,87 @@ const GeneralInitForm = forwardRef<GeneralInitFormForwardRefContent>(
onClick={handlerHostNameSuggest} onClick={handlerHostNameSuggest}
/> />
), ),
inputProps: {
style: {
minWidth: '4em',
},
},
sx: {
minWidth: 'min-content',
},
}} }}
label="Host name" label="Host name"
onChange={() => { onChange={() => {
setIsShowHostNameSuggest(isHostNamePrereqFilled()); setIsShowHostNameSuggest(isHostNamePrereqFilled());
}} }}
onHelp={() => {
setHelpText(
buildHelpMessage(
"Host name for this striker. It's usually a good idea to use the auto-generated value.",
),
);
}}
/> />
} }
ref={hostNameInputRef} ref={hostNameInputRef}
/> />
</FlexBox> </FlexBox>
</MUIBox> </MUIGrid>
<MUIGrid item xs={1} sm={2} md={1}>
<MUIGrid
columns={{ xs: 1, sm: 2, md: 1 }}
container
spacing="1em"
sx={{
'& > * > *': {
width: '100%',
},
}}
>
<MUIGrid item xs={1}>
<InputWithRef
input={
<OutlinedInputWithLabel
id="striker-init-general-admin-password"
inputProps={{
inputProps: {
type: 'password',
},
}}
label="Admin password"
onHelp={() => {
setHelpText(
buildHelpMessage(
"Password use to login to this Striker and connect to its database. Don't reuse an existing password here because it'll be stored as plaintext.",
),
);
}}
/>
}
ref={adminPasswordInputRef}
/>
</MUIGrid>
<MUIGrid item xs={1}>
<InputWithRef
input={
<OutlinedInputWithLabel
id="striker-init-general-confirm-admin-password"
inputProps={{
inputProps: {
type: 'password',
},
}}
label="Confirm password"
/>
}
ref={confirmAdminPasswordInputRef}
/>
</MUIGrid>
</MUIGrid>
</MUIGrid>
</MUIGrid>
{helpMessage && (
<MessageBox
onClose={() => {
setHelpText(undefined);
}}
>
{helpMessage}
</MessageBox>
)}
</FlexBox>
); );
}, },
); );

Loading…
Cancel
Save