This repository has been archived by the owner on Feb 18, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 24
/
Help.php
180 lines (152 loc) · 3.69 KB
/
Help.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?php
namespace Comodolab\Nova\Fields\Help;
use Laravel\Nova\Fields\Field;
class Help extends Field
{
/**
* The field's component.
*
* @var string
*/
public $component = 'help';
/**
* The meta data for the element.
*
* @var array
*/
public $meta = [
'sideLabel' => false,
'icon' => 'help'
];
/**
* By default hide on index.
*
* @var bool
*/
public $showOnIndex = false;
/**
* Default icons in svg format.
*
* @var array
*/
protected $svgIcons = [];
/**
* The text alignment for the field's text in tables.
*
* @var string
*/
public $textAlign = 'center';
/**
* Help constructor.
*
* @param string $name
* @param string|callable|null $message
*/
public function __construct(string $name = '', $message = null)
{
parent::__construct($name, null, null);
if ($message) {
$this->message($message);
}
$this->loadDefaultIcons()->icon('help');
}
private function loadDefaultIcons(): self
{
$this->svgIcons = require(dirname(__DIR__) . '/icons.php');
return $this;
}
/**
* @param string $title
* @param string|callable|null $message
*
* @return self
*/
public static function info(string $title = '', $message = null): self
{
return static::make($title, $message)
->type('info')
->icon('info');
}
/**
* @param string $title
* @param string|callable|null $message
*
* @return self
*/
public static function warning(string $title = '', $message = null): self
{
return static::make($title, $message)
->type('warning')
->icon('warning');
}
/**
* @param string $title
* @param string|callable|null $message
*
* @return self
*/
public static function danger(string $title = '', $message = null): self
{
return static::make($title, $message)
->type('danger')
->icon('danger');
}
/**
* @param string $title
* @param string|callable|null $message
*
* @return self
*/
public static function header(string $title = '', $message = null)
{
return static::make($title, $message)
->type('header')
->showFullWidthOnDetail()
->withoutIcon();
}
public function type(string $type): self
{
return $this->withMeta(compact('type'));
}
/**
* @param string|callable $message
* @return Help
*/
public function message($message): self
{
if (is_callable($message)) {
$message = (string)$message();
}
return $this->withMeta(compact('message'));
}
public function withSideLabel(): self
{
return $this->withMeta(['sideLabel' => true]);
}
public function displayAsHtml(): self
{
return $this->withMeta(['asHtml' => true]);
}
public function icon(string $icon): self
{
if ($svg = array_get($this->svgIcons, $icon)) {
$icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">' . $svg . '</svg>';
}
return $this->withMeta(compact('icon'));
}
public function withoutIcon(): self
{
return $this->withMeta(['icon' => null]);
}
public function showFullWidthOnDetail(): self
{
$this->showOnDetail = true;
return $this
->withMeta(['fullWidthOnDetail' => true]);
}
public function alsoOnIndex(): self
{
$this->showOnIndex = true;
return $this;
}
}