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

Advanced link fields #16268

Merged
merged 8 commits into from
Dec 8, 2024
Merged

Advanced link fields #16268

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
489fafa
Advanced link fields
brandonkelly Dec 4, 2024
bf3c772
Merge branch '5.6' into feature/cms-1354-advanced-link-fields
brandonkelly Dec 7, 2024
0d22d8d
Merge branch '5.6' into feature/cms-1354-advanced-link-fields
brandonkelly Dec 8, 2024
ee95163
Use a button
brandonkelly Dec 8, 2024
478012e
Merge branch '5.6' into feature/cms-1354-advanced-link-fields
brandonkelly Dec 8, 2024
ac0f18e
A11y/UI fixes
brandonkelly Dec 8, 2024
a45b231
Random value bugfix
brandonkelly Dec 8, 2024
f7a61c5
Release notes
brandonkelly Dec 8, 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
188 changes: 140 additions & 48 deletions src/fields/Link.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
use craft\helpers\Cp;
use craft\helpers\Html;
use craft\helpers\StringHelper;
use craft\helpers\Template;
use craft\validators\ArrayValidator;
use craft\validators\StringValidator;
use GraphQL\Type\Definition\InputObjectType;
Expand Down Expand Up @@ -103,6 +104,11 @@ public static function dbType(): array
'label' => Schema::TYPE_STRING,
'urlSuffix' => Schema::TYPE_STRING,
'target' => Schema::TYPE_STRING,
'title' => Schema::TYPE_STRING,
'class' => Schema::TYPE_STRING,
'id' => Schema::TYPE_STRING,
'rel' => Schema::TYPE_STRING,
'ariaLabel' => Schema::TYPE_STRING,
];
}

Expand Down Expand Up @@ -149,16 +155,11 @@ private static function types(): array
public bool $showLabelField = false;

/**
* @var bool Whether the “URL Suffix” field should be shown.
* @var string[] Attribute fields to show.
* @phpstan-var array<'urlSuffix'|'target'|'title'|'class'|'id'|'rel'|'ariaLabel'>
* @since 5.6.0
*/
public bool $showUrlSuffixField = false;

/**
* @var bool Whether the “Open in a new tab” field should be shown.
* @since 5.5.0
*/
public bool $showTargetField = false;
public array $advancedFields = [];

/**
* @var array<string,BaseLinkType>
Expand Down Expand Up @@ -208,6 +209,18 @@ public function __construct($config = [])
unset($config['placeholder']);
}

$config['advancedFields'] ??= [];

if (isset($config['showTargetField'])) {
unset($config['showTargetField']);
$config['advancedFields'][] = 'target';
}

if (isset($config['showUrlSuffixField'])) {
unset($config['showUrlSuffixField']);
$config['advancedFields'][] = 'urlSuffix';
}

if (isset($config['graphqlMode'])) {
$config['fullGraphqlData'] = ArrayHelper::remove($config, 'graphqlMode') === 'full';
}
Expand Down Expand Up @@ -242,6 +255,25 @@ protected function defineRules(): array
return $rules;
}

/**
* @deprecated in 5.6.0
* @return bool
*/
public function getShowTargetField(): bool
{
return in_array('target', $this->advancedFields);
}

/**
* @deprecated in 5.6.0
*/
public function setShowTargetField(bool $showTargetField): void
{
if (!$this->getShowTargetField()) {
$this->advancedFields[] = 'target';
}
}

/**
* Returns the link types available to the field.
*
Expand Down Expand Up @@ -380,17 +412,21 @@ public function getSettingsHtml(): ?string
'name' => 'showLabelField',
'on' => $this->showLabelField,
]) .
Cp::lightswitchFieldHtml([
'label' => Craft::t('app', 'Show the “URL Suffix” field'),
'id' => 'show-url-suffix-field',
'name' => 'showUrlSuffixField',
'on' => $this->showUrlSuffixField,
]) .
Cp::lightswitchFieldHtml([
'label' => Craft::t('app', 'Show the “Open in a new tab” field'),
'id' => 'show-target-field',
'name' => 'showTargetField',
'on' => $this->showTargetField,
Cp::checkboxSelectFieldHtml([
'label' => Craft::t('app', 'Advanced Fields'),
'id' => 'attribute-fields',
'name' => 'advancedFields',
'options' => [
['label' => Craft::t('app', 'URL Suffix'), 'value' => 'urlSuffix'],
['label' => Craft::t('app', 'Target'), 'value' => 'target'],
['label' => Craft::t('app', 'Title Text'), 'value' => 'title'],
['label' => Craft::t('app', 'Class Name'), 'value' => 'class'],
['label' => Craft::t('app', 'ID'), 'value' => 'id'],
['label' => Template::raw(Craft::t('app', 'Relation ({ex})', ['ex' => '<code>rel</code>'])), 'value' => 'rel'],
['label' => Craft::t('app', 'ARIA Label'), 'value' => 'ariaLabel'],
],
'values' => $this->advancedFields,
'sortable' => true,
]) .
Html::tag('hr') .
Html::a(Craft::t('app', 'Advanced'), options: [
Expand Down Expand Up @@ -457,9 +493,7 @@ public function normalizeValue(mixed $value, ?ElementInterface $element): mixed
$type = $value->getType();
$value = [
'type' => $type,
$type => [
'value' => sprintf('{%s:%s@%s:url}', $linkedElement::refHandle(), $linkedElement->id, $element->siteId),
],
'value' => sprintf('{%s:%s@%s:url}', $linkedElement::refHandle(), $linkedElement->id, $element->siteId),
];
}
}
Expand All @@ -474,9 +508,18 @@ public function normalizeValue(mixed $value, ?ElementInterface $element): mixed
if (is_array($value)) {
$typeId = $value['type'] ?? UrlType::id();
$config = array_filter([
'label' => $this->showLabelField ? ($value['label'] ?? null) : null,
'urlSuffix' => $this->showUrlSuffixField ? ($value['urlSuffix'] ?? null) : null,
'target' => $this->showTargetField ? ($value['target'] ?? null) : null,
'label' => (isset($value['label']) && $this->showLabelField) ? $value['label'] : null,
'urlSuffix' => (isset($value['urlSuffix']) && in_array('urlSuffix', $this->advancedFields)) ? $value['urlSuffix'] : null,
'target' => (isset($value['target']) && in_array('target', $this->advancedFields)) ? $value['target'] : null,
'title' => (isset($value['title']) && in_array('title', $this->advancedFields)) ? $value['title'] : null,
'class' => (isset($value['class']) && in_array('class', $this->advancedFields))
? (implode(' ', array_map(fn(string $class) => Html::id($class), explode(' ', $value['class']))))
: null,
'id' => (isset($value['id']) && in_array('id', $this->advancedFields)) ? Html::id($value['id']) : null,
'rel' => (isset($value['rel']) && in_array('rel', $this->advancedFields))
? (implode(' ', array_map(fn(string $class) => Html::id($class), explode(' ', $value['rel']))))
: null,
'ariaLabel' => (isset($value['ariaLabel']) && in_array('ariaLabel', $this->advancedFields)) ? $value['ariaLabel'] : null,
]);
$value = $value['value'] ?? $value[$typeId]['value'] ?? '';

Expand Down Expand Up @@ -629,7 +672,7 @@ protected function inputHtml(mixed $value, ?ElementInterface $element, bool $inl
Html::endTag('div');
}

$pane = $this->showLabelField || $this->showUrlSuffixField || $this->showTargetField;
$pane = $this->showLabelField || !empty($this->advancedFields);
$html =
Html::beginTag('div', [
'id' => $id,
Expand Down Expand Up @@ -658,29 +701,78 @@ protected function inputHtml(mixed $value, ?ElementInterface $element, bool $inl
]);
}

if ($this->showUrlSuffixField) {
$html .= Cp::textFieldHtml([
'fieldClass' => ['my-m', 'info-icon-instructions'],
'label' => Craft::t('app', 'URL Suffix'),
'instructions' => Craft::t('app', 'Query params (e.g. {ex1}) or a URI fragment (e.g. {ex2}) that should be appended to the URL.', [
'ex1' => '`?p1=foo&p2=bar`',
'ex2' => '`#anchor`',
]),
'id' => "$id-url-suffix",
'name' => "$this->handle[urlSuffix]",
'value' => $value?->urlSuffix,
]);
}
if (!empty($this->advancedFields)) {
$html .=
Html::a(Craft::t('app', 'Advanced'), options: [
'class' => ['fieldtoggle', 'mb-0'],
'data' => ['target' => "$id-advanced"],
]) .
Html::beginTag('div', [
'id' => "$id-advanced",
'class' => ['hidden', 'meta', 'pane', 'hairline'],
]);

if ($this->showTargetField) {
$html .= Cp::lightswitchFieldHtml([
'fieldClass' => 'my-m',
'label' => Craft::t('app', 'Open in a new tab'),
'id' => "$id-target",
'name' => "$this->handle[target]",
'on' => $value?->target,
'value' => '_blank',
]);
foreach ($this->advancedFields as $field) {
$html .= match ($field) {
'urlSuffix' => Cp::textFieldHtml([
'fieldClass' => 'info-icon-instructions',
'label' => Craft::t('app', 'URL Suffix'),
'instructions' => Craft::t('app', 'Query params (e.g. {ex1}) or a URI fragment (e.g. {ex2}) that should be appended to the URL.', [
'ex1' => '`?p1=foo&p2=bar`',
'ex2' => '`#anchor`',
]),
'id' => "$id-url-suffix",
'name' => "$this->handle[urlSuffix]",
'value' => $value?->urlSuffix,
]),
'target' => Cp::lightswitchFieldHtml([
'label' => Craft::t('app', 'Open in a new tab'),
'id' => "$id-target",
'name' => "$this->handle[target]",
'on' => $value?->target,
'value' => '_blank',
]),
'title' => Cp::textFieldHtml([
'label' => Craft::t('app', 'Title Text'),
'id' => "$id-title",
'name' => "$this->handle[title]",
'value' => $value?->title,
]),
'class' => Cp::textFieldHtml([
'fieldClass' => 'info-icon-instructions',
'class' => 'code',
'label' => Craft::t('app', 'Class Name'),
'instructions' => Craft::t('app', 'Separate multiple values with spaces.'),
'id' => "$id-class",
'name' => "$this->handle[class]",
'value' => $value?->class,
]),
'id' => Cp::textFieldHtml([
'class' => 'code',
'label' => Craft::t('app', 'ID'),
'id' => "$id-id",
'name' => "$this->handle[id]",
'value' => $value?->id,
]),
'rel' => Cp::textfieldHtml([
'fieldClass' => 'info-icon-instructions',
'class' => 'code',
'label' => Craft::t('app', 'Relation ({ex})', ['ex' => '<code>rel</code>']),
'instructions' => Craft::t('app', 'Separate multiple values with spaces.'),
'id' => "$id-rel",
'name' => "$this->handle[rel]",
'value' => $value?->rel,
]),
'ariaLabel' => Cp::textFieldHtml([
'label' => Craft::t('app', 'ARIA Label'),
'id' => "$id-aria-label",
'name' => "$this->handle[ariaLabel]",
'value' => $value?->ariaLabel,
]),
};
}

$html .= Html::endTag('div');
}

$html .= Html::endTag('div');
Expand Down
44 changes: 42 additions & 2 deletions src/fields/data/LinkData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,36 @@ class LinkData extends BaseObject implements Serializable
*/
public ?string $target = null;

/**
* @var string|null The link’s `title` attribute.
* @since 5.6.0
*/
public ?string $title = null;

/**
* @var string|null The link’s `class` attribute.
* @since 5.6.0
*/
public ?string $class = null;

/**
* @var string|null The link’s `id` attribute.
* @since 5.6.0
*/
public ?string $id = null;

/**
* @var string|null The link’s `rel` attribute.
* @since 5.6.0
*/
public ?string $rel = null;

/**
* @var string|null The link’s `aria-label` attribute.
* @since 5.6.0
*/
public ?string $ariaLabel = null;

private string $renderedValue;
private ?string $label = null;

Expand Down Expand Up @@ -129,6 +159,11 @@ public function getLink(): Markup
$label = $this->getLabel();
$html = Html::a(Html::encode($label !== '' ? $label : $url), $url, [
'target' => $this->target,
'title' => $this->title,
'class' => $this->class,
'id' => $this->id,
'rel' => $this->rel,
'ariaLabel' => $this->ariaLabel,
]);
}

Expand All @@ -150,12 +185,17 @@ public function getElement(): ?ElementInterface

public function serialize(): mixed
{
return [
return array_filter([
'value' => $this->value,
'type' => $this->getType(),
'label' => $this->label,
'urlSuffix' => $this->urlSuffix,
'target' => $this->target,
];
'title' => $this->title,
'class' => $this->class,
'id' => $this->id,
'rel' => $this->rel,
'ariaLabel' => $this->ariaLabel,
]);
}
}
1 change: 1 addition & 0 deletions src/gql/types/LinkData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ protected function resolve(mixed $source, array $arguments, mixed $context, Reso
'value' => $source->getValue(),
'label' => $source->getLabel(true),
'url' => $source->getUrl(),
'link' => $source->getLink(),
'elementType' => $source->getElement() ? $source->getElement()::class : null,
'elementId' => $source->getElement()?->id,
'elementSiteId' => $source->getElement()?->siteId,
Expand Down
7 changes: 7 additions & 0 deletions src/gql/types/generators/LinkDataType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ public static function generateType(mixed $context): ObjectType
'label' => Type::string(),
'urlSuffix' => Type::string(),
'url' => Type::string(),
'link' => Type::string(),
'target' => Type::string(),
'title' => Type::string(),
'class' => Type::string(),
'id' => Type::string(),
'rel' => Type::string(),
'ariaLabel' => Type::string(),
'elementType' => Type::string(),
'elementId' => Type::int(),
'elementSiteId' => Type::int(),
Expand Down
6 changes: 6 additions & 0 deletions src/translations/en/app.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
'A server error occurred.' => 'A server error occurred.',
'A subpath is required for this filesystem.' => 'A subpath is required for this filesystem.',
'A template name cannot contain NUL bytes.' => 'A template name cannot contain NUL bytes.',
'ARIA Label' => 'ARIA Label',
'Abandoned' => 'Abandoned',
'Abort the update' => 'Abort the update',
'Access the control panel when the system is offline' => 'Access the control panel when the system is offline',
Expand Down Expand Up @@ -297,6 +298,7 @@
'Choose' => 'Choose',
'City' => 'City',
'City/Town' => 'City/Town',
'Class Name' => 'Class Name',
'Class' => 'Class',
'Clear Caches' => 'Clear Caches',
'Clear all' => 'Clear all',
Expand Down Expand Up @@ -1293,6 +1295,7 @@
'Relate {type} from a specific site?' => 'Relate {type} from a specific site?',
'Related To' => 'Related To',
'Related {type} Title' => 'Related {type} Title',
'Relation ({ex})' => 'Relation ({ex})',
'Relations don’t store the selected site, so this should only be enabled if some {type} aren’t propagated to all sites.' => 'Relations don’t store the selected site, so this should only be enabled if some {type} aren’t propagated to all sites.',
'Release all jobs' => 'Release all jobs',
'Release job' => 'Release job',
Expand Down Expand Up @@ -1433,6 +1436,7 @@
'Send' => 'Send',
'Sender Name' => 'Sender Name',
'Sendmail Command' => 'Sendmail Command',
'Separate multiple values with spaces.' => 'Separate multiple values with spaces.',
'Server Error' => 'Server Error',
'Server' => 'Server',
'Service Unavailable' => 'Service Unavailable',
Expand Down Expand Up @@ -1570,6 +1574,7 @@
'Tag group saved.' => 'Tag group saved.',
'Tag' => 'Tag',
'Tags' => 'Tags',
'Target' => 'Target',
'Teal' => 'Teal',
'Team permissions can be managed from {link}.' => 'Team permissions can be managed from {link}.',
'Team permissions can be managed from {path} on a development environment.' => 'Team permissions can be managed from {path} on a development environment.',
Expand Down Expand Up @@ -1743,6 +1748,7 @@
'Time' => 'Time',
'Tip' => 'Tip',
'Tip:' => 'Tip:',
'Title Text' => 'Title Text',
'Title' => 'Title',
'To complete the update, some changes must be made to your database.' => 'To complete the update, some changes must be made to your database.',
'To install this plugin with composer, copy the command above to your terminal.' => 'To install this plugin with composer, copy the command above to your terminal.',
Expand Down
Loading
Loading