mirror of
https://github.com/shlinkio/shlink-web-client.git
synced 2026-08-01 16:41:53 +00:00
Allowed to dynamically determine how short URL suggestions are calculated
This commit is contained in:
@@ -20,8 +20,8 @@ const Settings = (RealTimeUpdates: FC, ShortUrlCreation: FC, UserInterface: FC,
|
|||||||
<NoMenuLayout>
|
<NoMenuLayout>
|
||||||
<SettingsSections
|
<SettingsSections
|
||||||
items={[
|
items={[
|
||||||
[ <UserInterface />, <ShortUrlCreation /> ], // eslint-disable-line react/jsx-key
|
[ <UserInterface />, <Visits /> ], // eslint-disable-line react/jsx-key
|
||||||
[ <Visits />, <RealTimeUpdates /> ], // eslint-disable-line react/jsx-key
|
[ <ShortUrlCreation />, <RealTimeUpdates /> ], // eslint-disable-line react/jsx-key
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
</NoMenuLayout>
|
</NoMenuLayout>
|
||||||
|
|||||||
@@ -1,29 +1,62 @@
|
|||||||
import { FC } from 'react';
|
import { FC, ReactNode } from 'react';
|
||||||
import { FormGroup } from 'reactstrap';
|
import { DropdownItem, FormGroup } from 'reactstrap';
|
||||||
import { SimpleCard } from '../utils/SimpleCard';
|
import { SimpleCard } from '../utils/SimpleCard';
|
||||||
import ToggleSwitch from '../utils/ToggleSwitch';
|
import ToggleSwitch from '../utils/ToggleSwitch';
|
||||||
import { Settings, ShortUrlCreationSettings } from './reducers/settings';
|
import { DropdownBtn } from '../utils/DropdownBtn';
|
||||||
|
import { Settings, ShortUrlCreationSettings, TagFilteringMode } from './reducers/settings';
|
||||||
|
|
||||||
interface ShortUrlCreationProps {
|
interface ShortUrlCreationProps {
|
||||||
settings: Settings;
|
settings: Settings;
|
||||||
setShortUrlCreationSettings: (settings: ShortUrlCreationSettings) => void;
|
setShortUrlCreationSettings: (settings: ShortUrlCreationSettings) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const ShortUrlCreation: FC<ShortUrlCreationProps> = (
|
const tagFilteringModeText = (tagFilteringMode: TagFilteringMode | undefined): string =>
|
||||||
{ settings: { shortUrlCreation }, setShortUrlCreationSettings },
|
tagFilteringMode === 'includes' ? 'Suggest tags including input' : 'Suggest tags starting with input';
|
||||||
) => (
|
const tagFilteringModeHint = (tagFilteringMode: TagFilteringMode | undefined): ReactNode =>
|
||||||
<SimpleCard title="Short URLs creation" className="h-100">
|
tagFilteringMode === 'includes'
|
||||||
<FormGroup className="mb-0">
|
? <>The list of suggested tags will contain existing ones <b>including</b> provided input.</>
|
||||||
<ToggleSwitch
|
: <>The list of suggested tags will contain existing ones <b>starting with</b> provided input.</>;
|
||||||
checked={shortUrlCreation?.validateUrls ?? false}
|
|
||||||
onChange={(validateUrls) => setShortUrlCreationSettings({ validateUrls })}
|
export const ShortUrlCreation: FC<ShortUrlCreationProps> = ({ settings, setShortUrlCreationSettings }) => {
|
||||||
>
|
const shortUrlCreation: ShortUrlCreationSettings = settings.shortUrlCreation ?? { validateUrls: false };
|
||||||
By default, request validation on long URLs when creating new short URLs.
|
const changeTagsFilteringMode = (tagFilteringMode: TagFilteringMode) => () => setShortUrlCreationSettings(
|
||||||
|
{ ...shortUrlCreation ?? { validateUrls: false }, tagFilteringMode },
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<SimpleCard title="Short URLs creation" className="h-100">
|
||||||
|
<FormGroup>
|
||||||
|
<ToggleSwitch
|
||||||
|
checked={shortUrlCreation.validateUrls ?? false}
|
||||||
|
onChange={(validateUrls) => setShortUrlCreationSettings({ ...shortUrlCreation, validateUrls })}
|
||||||
|
>
|
||||||
|
By default, request validation on long URLs when creating new short URLs.
|
||||||
|
<small className="form-text text-muted">
|
||||||
|
The initial state of the <b>Validate URL</b> checkbox will
|
||||||
|
be <b>{shortUrlCreation.validateUrls ? 'checked' : 'unchecked'}</b>.
|
||||||
|
</small>
|
||||||
|
</ToggleSwitch>
|
||||||
|
</FormGroup>
|
||||||
|
<FormGroup className="mb-0">
|
||||||
|
<label>Tag suggestions search mode:</label>
|
||||||
|
<DropdownBtn text={tagFilteringModeText(shortUrlCreation.tagFilteringMode)}>
|
||||||
|
<DropdownItem
|
||||||
|
active={!shortUrlCreation.tagFilteringMode || shortUrlCreation.tagFilteringMode === 'startsWith'}
|
||||||
|
onClick={changeTagsFilteringMode('startsWith')}
|
||||||
|
>
|
||||||
|
{tagFilteringModeText('startsWith')}
|
||||||
|
</DropdownItem>
|
||||||
|
<DropdownItem
|
||||||
|
active={shortUrlCreation.tagFilteringMode === 'includes'}
|
||||||
|
onClick={changeTagsFilteringMode('includes')}
|
||||||
|
>
|
||||||
|
{tagFilteringModeText('includes')}
|
||||||
|
</DropdownItem>
|
||||||
|
</DropdownBtn>
|
||||||
<small className="form-text text-muted">
|
<small className="form-text text-muted">
|
||||||
The initial state of the <b>Validate URL</b> checkbox will
|
{tagFilteringModeHint(shortUrlCreation.tagFilteringMode)}
|
||||||
be <b>{shortUrlCreation?.validateUrls ? 'checked' : 'unchecked'}</b>.
|
|
||||||
</small>
|
</small>
|
||||||
</ToggleSwitch>
|
</FormGroup>
|
||||||
</FormGroup>
|
</SimpleCard>
|
||||||
</SimpleCard>
|
);
|
||||||
);
|
}
|
||||||
|
|||||||
@@ -17,12 +17,11 @@ interface RealTimeUpdatesSettings {
|
|||||||
interval?: number;
|
interval?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
type TagFilteringMode = 'startsWith' | 'includes';
|
export type TagFilteringMode = 'startsWith' | 'includes';
|
||||||
|
|
||||||
export interface ShortUrlCreationSettings {
|
export interface ShortUrlCreationSettings {
|
||||||
validateUrls: boolean;
|
validateUrls: boolean;
|
||||||
tagFilteringMode?: TagFilteringMode;
|
tagFilteringMode?: TagFilteringMode
|
||||||
maxTagSuggestions?: number;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface UiSettings {
|
export interface UiSettings {
|
||||||
|
|||||||
@@ -28,7 +28,6 @@ const TagsSelector = (colorGenerator: ColorGenerator) => (
|
|||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const searchMode = settings.shortUrlCreation?.tagFilteringMode ?? 'startsWith';
|
const searchMode = settings.shortUrlCreation?.tagFilteringMode ?? 'startsWith';
|
||||||
const maxSuggestions = settings.shortUrlCreation?.maxTagSuggestions;
|
|
||||||
const ReactTagsTag = ({ tag, onDelete }: TagComponentProps) =>
|
const ReactTagsTag = ({ tag, onDelete }: TagComponentProps) =>
|
||||||
<Tag colorGenerator={colorGenerator} text={tag.name} clearable className="react-tags__tag" onClose={onDelete} />;
|
<Tag colorGenerator={colorGenerator} text={tag.name} clearable className="react-tags__tag" onClose={onDelete} />;
|
||||||
const ReactTagsSuggestion = ({ item }: SuggestionComponentProps) => (
|
const ReactTagsSuggestion = ({ item }: SuggestionComponentProps) => (
|
||||||
@@ -48,7 +47,6 @@ const TagsSelector = (colorGenerator: ColorGenerator) => (
|
|||||||
addOnBlur
|
addOnBlur
|
||||||
placeholderText={placeholder ?? 'Add tags to the URL'}
|
placeholderText={placeholder ?? 'Add tags to the URL'}
|
||||||
minQueryLength={1}
|
minQueryLength={1}
|
||||||
maxSuggestionsLength={maxSuggestions}
|
|
||||||
delimiters={[ 'Enter', 'Tab', ',' ]}
|
delimiters={[ 'Enter', 'Tab', ',' ]}
|
||||||
suggestionsTransform={
|
suggestionsTransform={
|
||||||
searchMode === 'includes'
|
searchMode === 'includes'
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ import { Mock } from 'ts-mockery';
|
|||||||
import { ShortUrlCreationSettings, Settings } from '../../src/settings/reducers/settings';
|
import { ShortUrlCreationSettings, Settings } from '../../src/settings/reducers/settings';
|
||||||
import { ShortUrlCreation } from '../../src/settings/ShortUrlCreation';
|
import { ShortUrlCreation } from '../../src/settings/ShortUrlCreation';
|
||||||
import ToggleSwitch from '../../src/utils/ToggleSwitch';
|
import ToggleSwitch from '../../src/utils/ToggleSwitch';
|
||||||
|
import { DropdownBtn } from '../../src/utils/DropdownBtn';
|
||||||
|
import { DropdownItem } from 'reactstrap';
|
||||||
|
|
||||||
describe('<ShortUrlCreation />', () => {
|
describe('<ShortUrlCreation />', () => {
|
||||||
let wrapper: ShallowWrapper;
|
let wrapper: ShallowWrapper;
|
||||||
@@ -25,13 +27,41 @@ describe('<ShortUrlCreation />', () => {
|
|||||||
[{ validateUrls: true }, true ],
|
[{ validateUrls: true }, true ],
|
||||||
[{ validateUrls: false }, false ],
|
[{ validateUrls: false }, false ],
|
||||||
[ undefined, false ],
|
[ undefined, false ],
|
||||||
])('switch is toggled if option is true', (shortUrlCreation, expectedChecked) => {
|
])('URL validation switch is toggled if option is true', (shortUrlCreation, expectedChecked) => {
|
||||||
const wrapper = createWrapper(shortUrlCreation);
|
const wrapper = createWrapper(shortUrlCreation);
|
||||||
const toggle = wrapper.find(ToggleSwitch);
|
const toggle = wrapper.find(ToggleSwitch);
|
||||||
|
|
||||||
expect(toggle.prop('checked')).toEqual(expectedChecked);
|
expect(toggle.prop('checked')).toEqual(expectedChecked);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
[{ validateUrls: true }, 'checkbox will be checked' ],
|
||||||
|
[{ validateUrls: false }, 'checkbox will be unchecked' ],
|
||||||
|
[ undefined, 'checkbox will be unchecked' ],
|
||||||
|
])('shows expected helper text for URL validation', (shortUrlCreation, expectedText) => {
|
||||||
|
const wrapper = createWrapper(shortUrlCreation);
|
||||||
|
const text = wrapper.find('.form-text').first();
|
||||||
|
|
||||||
|
expect(text.text()).toContain(expectedText);
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
[ { tagFilteringMode: 'includes' } as ShortUrlCreationSettings, 'Suggest tags including input', 'including' ],
|
||||||
|
[
|
||||||
|
{ tagFilteringMode: 'startsWith' } as ShortUrlCreationSettings,
|
||||||
|
'Suggest tags starting with input',
|
||||||
|
'starting with',
|
||||||
|
],
|
||||||
|
[ undefined, 'Suggest tags starting with input', 'starting with' ],
|
||||||
|
])('shows expected texts for tags suggestions', (shortUrlCreation, expectedText, expectedHint) => {
|
||||||
|
const wrapper = createWrapper(shortUrlCreation);
|
||||||
|
const hintText = wrapper.find('.form-text').last();
|
||||||
|
const dropdown = wrapper.find(DropdownBtn);
|
||||||
|
|
||||||
|
expect(dropdown.prop('text')).toEqual(expectedText);
|
||||||
|
expect(hintText.text()).toContain(expectedHint);
|
||||||
|
});
|
||||||
|
|
||||||
it.each([[ true ], [ false ]])('invokes setShortUrlCreationSettings when toggle value changes', (validateUrls) => {
|
it.each([[ true ], [ false ]])('invokes setShortUrlCreationSettings when toggle value changes', (validateUrls) => {
|
||||||
const wrapper = createWrapper();
|
const wrapper = createWrapper();
|
||||||
const toggle = wrapper.find(ToggleSwitch);
|
const toggle = wrapper.find(ToggleSwitch);
|
||||||
@@ -41,14 +71,21 @@ describe('<ShortUrlCreation />', () => {
|
|||||||
expect(setShortUrlCreationSettings).toHaveBeenCalledWith({ validateUrls });
|
expect(setShortUrlCreationSettings).toHaveBeenCalledWith({ validateUrls });
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it('invokes setShortUrlCreationSettings when dropdown value changes', () => {
|
||||||
[{ validateUrls: true }, 'checkbox will be checked' ],
|
const wrapper = createWrapper();
|
||||||
[{ validateUrls: false }, 'checkbox will be unchecked' ],
|
const firstDropdownItem = wrapper.find(DropdownItem).first();
|
||||||
[ undefined, 'checkbox will be unchecked' ],
|
const secondDropdownItem = wrapper.find(DropdownItem).last();
|
||||||
])('shows expected helper text', (shortUrlCreation, expectedText) => {
|
|
||||||
const wrapper = createWrapper(shortUrlCreation);
|
|
||||||
const text = wrapper.find('.form-text');
|
|
||||||
|
|
||||||
expect(text.text()).toContain(expectedText);
|
expect(setShortUrlCreationSettings).not.toHaveBeenCalled();
|
||||||
|
|
||||||
|
firstDropdownItem.simulate('click');
|
||||||
|
expect(setShortUrlCreationSettings).toHaveBeenCalledWith(expect.objectContaining(
|
||||||
|
{ tagFilteringMode: 'startsWith' },
|
||||||
|
));
|
||||||
|
|
||||||
|
secondDropdownItem.simulate('click');
|
||||||
|
expect(setShortUrlCreationSettings).toHaveBeenCalledWith(expect.objectContaining(
|
||||||
|
{ tagFilteringMode: 'includes' },
|
||||||
|
));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user