Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

12.4 KB
Raw Blame
{{ define "admin-subscribers" -}}
{{ template "admin-header" . }}
{{- $d := .Data -}}
{{- $subStatus := $d.Page.Param "subscription_status" -}}
{{- $status := $d.Page.Param "status" -}}
{{- $base := URI "/admin/subscribers" -}}
{{- $statusIcons := dict "confirmed" "check" "blocklisted" "x-circle" "disabled" "pause-circle" "unsubscribed" "x" "unconfirmed" "help-circle" -}}
{{- if $d.CurrentList }}{{ $base = printf "%s/lists/%d" (URI "/admin/subscribers") $d.CurrentList.ID }}{{ end -}}

<script>
	window._lists = {{ ToJSON $d.AllLists }};
	window._filters = {
		listIDs: {{ if $d.CurrentList }}[{{ $d.CurrentList.ID }}]{{ else }}{{ ToJSON (index $d.Page.QueryParams "list_id") }}{{ end }},
		search: {{ ToJSON $d.Page.Search }},
		query: {{ ToJSON $d.Page.Query }},
		subStatus: {{ ToJSON $subStatus }},
		status: {{ ToJSON $status }}
	};
</script>

<section class="subscribers" x-data="subscribersView()">
	<header class="hstack justify-between page-header">
		<div class="hstack page-heading">
			<h1 class="page-title">
				{{ .L.T "globals.terms.subscribers" }}
				<span>({{ $d.Page.Total }})</span>
			</h1>
			{{- if $d.CurrentList }} {{ template "filter-badge" dict "Label" $d.CurrentList.Name "LabelURL" (printf "%s/%d" (URI "/admin/lists") $d.CurrentList.ID) "Avatar" (dict "Size" "xsmall" "Kind" "list" "Name" $d.CurrentList.Name "Disabled" (eq $d.CurrentList.Status "archived")) "URL" (URI "/admin/subscribers") }}{{ end }}
			{{- if eq $subStatus "none" }} {{ template "filter-badge" dict "Label" (.L.Tc "dashboard.orphanSubs" 2) "URL" ($d.Page.FilterURL $base "subscription_status") }}
			{{- else if $subStatus }} {{ template "filter-badge" dict "Label" (list (Dot) (.L.T (printf "globals.terms.%s" $subStatus))) "Class" (printf "status-%s" $subStatus) "URL" ($d.Page.FilterURL $base "subscription_status") }}{{ end }}
			{{- if $status }} {{ template "filter-badge" dict "Label" (list (Dot) (.L.T (printf "globals.terms.%s" $status))) "Class" (printf "status-%s" $status) "URL" ($d.Page.FilterURL $base "status") }}{{ end }}
			{{- if gt $d.Page.Page 1 }} {{ template "filter-badge" dict "Label" (.L.Ts "globals.terms.page" "n" (printf "%d" $d.Page.Page)) "URL" ($d.Page.FilterURL $base) }}{{ end }}
		</div>
		<div class="hstack justify-end buttons">
			<form action="{{ $base }}" class="search-form" :method="advanced ? 'post' : 'get'">
				{{- $d.Page.FormFields "search" "query" "page" -}}
				<ot-dropdown>
					<fieldset class="group">
						<input name="search" aria-label="{{ .L.T "globals.buttons.search" }}" data-testid="search" placeholder="{{ .L.T "subscribers.queryPlaceholder" }}" value="{{ $d.Page.Search }}" :disabled="isSqlOpen || advanced" autofocus />
						<button type="button" class="outline sql-btn dot-indicator" :class="{ 'is-active': advanced, external: !advanced }" popovertarget="sql-editor" data-testid="btn-advanced-search" :data-variant="advanced ? 'primary' : null" aria-label="{{ .L.T "globals.terms.advanced" }}">SQL {}</button>
						<button type="submit" data-testid="btn-search" aria-label="{{ .L.T "globals.buttons.search" }}">{{ Icon "search" }}</button>
					</fieldset>
					<div popover id="sql-editor" class="sql-editor" data-testid="query-editor" @toggle="isSqlOpen = ($event.newState === 'open'); if (isSqlOpen) $nextTick(() => $refs.queryInput.focus())">
						<div data-field>
							<textarea x-ref="queryInput" name="query" data-testid="query" rows="6" placeholder="subscribers.name LIKE '%user%' or subscribers.status='blocklisted'" x-model="query" :disabled="!isSqlOpen && !advanced"></textarea>
							<small data-hint>
								{{ .L.T "subscribers.advancedQueryHelp" }}.
								<a href="https://listmonk.app/docs/querying-and-segmentation" target="_blank" rel="noopener noreferrer">{{ .L.T "globals.buttons.learnMore" }}.</a>
							</small>
						</div>
						<div class="hstack justify-end buttons">
							<button type="button" class="outline" data-testid="btn-query-reset" @click="query = ''" :disabled="query.trim() === ''">{{ .L.T "globals.buttons.reset" }}</button>
							<button type="submit" data-variant="primary" data-testid="btn-query">{{ .L.T "globals.fields.query" }}</button>
						</div>
					</div>
				</ot-dropdown>
			</form>
			{{- if $d.Can "subscribers:manage" }}
				<a href="{{ URI "/admin/subscribers/new" }}" class="button" data-variant="primary" data-testid="btn-new">
					{{ Icon "plus" }} {{ .L.T "globals.buttons.new" }}
				</a>
			{{- end }}
		</div>
	</header>

	<div class="card page-content has-table">
		<div class="table-wrapper" x-data="table({ query: {{ ToJSON $d.Page.Query }}, filters: {{ ToJSON $d.Page.QueryParams }}, total: {{ $d.Page.Total }} })" :aria-busy="isLoading('subscribers')" @change="onChange($event)">
			<template x-if="numSelected > 0">
				<ot-dropdown class="bulk-actions" data-variant="primary">
					<button popovertarget="sub-bulk-actions" type="button" class="small" data-testid="btn-bulk-actions">
						<span x-text="numSelectedLabel"></span> {{ Icon "more-vertical" }}
					</button>
					<menu popover id="sub-bulk-actions">
						{{- if gt $d.Page.Total $d.Page.PerPage }}
							<button type="button" role="menuitem" class="ghost" data-testid="select-all-subscribers" x-cloak x-show="!allSelected" @click.prevent="onSelectAllQuery()">
								{{ Icon "check-square" }} <span x-text="selectAllLabel"></span>
							</button>
						{{- end }}
						<button type="button" role="menuitem" class="ghost" data-testid="btn-export-subscribers" @click.prevent="onExport(allSelected, selected, total)">{{ Icon "download-cloud" }} {{ .L.T "globals.buttons.export" }}</button>
						{{- if $d.Can "subscribers:manage" }}
							<button type="button" role="menuitem" class="ghost" data-testid="btn-manage-lists" @click.prevent="onOpenManageLists(allSelected, selected)">{{ Icon "list" }} {{ .L.T "subscribers.manageLists" }}</button>
							<button type="button" role="menuitem" class="ghost" data-testid="btn-manage-blocklist" @click.prevent="onBlocklistSelected(allSelected, selected, total)">{{ Icon "user-x" }} {{ .L.T "globals.terms.blocklist" }}</button>
							<hr />
							<button type="button" role="menuitem" class="ghost" data-variant="danger" data-testid="btn-delete-subscribers" :disabled="isLoading('subscribers')" @click.prevent="onDeleteSelected(allSelected, selected, total)">{{ Icon "trash-2" }} {{ .L.T "globals.buttons.delete" }} <span x-text="numSelected"></span></button>
						{{- end }}
					</menu>
				</ot-dropdown>
			</template>

			<table class="has-select">
				<thead>
					<tr>
						<th width="5%"><input type="checkbox" aria-label="{{ .L.T "globals.buttons.toggleSelect" }}"></th>
						<th width="48%">{{ $d.Page.SortLink $base "email" (.L.T "globals.fields.email") }}</th>
						<th width="18%">{{ $d.Page.SortLink $base "name" (.L.T "globals.fields.name") }}</th>
						<th>{{ $d.Page.SortLink $base "created_at" (.L.T "globals.fields.createdAt") }}</th>
						<th>{{ $d.Page.SortLink $base "updated_at" (.L.T "globals.fields.updatedAt") }}</th>
						<th class="align-right"></th>
					</tr>
				</thead>
				<tbody>
					{{- range $d.Subscribers }}
						{{- $sub := . }}
						<tr data-testid="sub-row" data-id="{{ .ID }}" {{ if eq .Status "blocklisted" }}class="blocklisted"{{ end }}>
							<td><input name="id" type="checkbox" value="{{ .ID }}"></td>
							<td class="email">
								<div class="avatar{{ if eq .Status "blocklisted" }} disabled{{ end }}">
									{{ template "avatar-icon" dict "Kind" "subscriber" "Name" (or .Name .Email) "Href" (printf "%s/%d" (URI "/admin/subscribers") .ID) "Title" (printf "%s %s" ($.L.T "globals.buttons.view") (or .Name .Email)) }}
									<div class="avatar-label">
										<a class="unstyled" href="{{ URI "/admin/subscribers" }}/{{ .ID }}">{{ .Email }}</a>
										{{- if ne .Status "enabled" }}
											{{- $label := $.L.T (printf "globals.terms.%s" .Status) }}
											<a href="{{ $base }}?status={{ .Status }}" class="status-icon status-{{ .Status }}" title="{{ $.L.T "globals.buttons.filter" }} {{ $label }}" aria-label="{{ $.L.T "globals.buttons.filter" }} {{ $label }}">{{ Icon (or (index $statusIcons .Status) "help-circle") }}</a>
										{{- end }}
										<div class="hstack lists">
											{{- range $i, $l := .ParsedLists }}
												{{- if lt $i 3 }}
													<div class="avatar xsmall">
														{{- $label := $.L.T (printf "globals.terms.%s" $l.SubscriptionStatus) }}
														<a class="unstyled avatar-icon avatar-list" href="{{ URI "/admin/lists" }}/{{ $l.ID }}" title="{{ $.L.T "globals.buttons.view" }} {{ $l.Name }}: {{ $label }}" aria-label="{{ $.L.T "globals.buttons.view" }} {{ $l.Name }}: {{ $label }}"><span class="badge enum status-{{ $l.SubscriptionStatus }}" aria-hidden="true">{{ if eq $l.SubscriptionStatus "unconfirmed" }}?{{ else }}{{ Icon (or (index $statusIcons $l.SubscriptionStatus) "help-circle") }}{{ end }}</span></a>
														<a class="unstyled text-light avatar-label" href="{{ URI "/admin/subscribers/lists" }}/{{ $l.ID }}" title="{{ $.L.T "globals.buttons.filter" }} {{ $l.Name }}">{{ $l.Name }}</a>
													</div>
												{{- end }}
											{{- end }}
											{{- if gt (len .ParsedLists) 3 }}
												<a href="{{ URI "/admin/subscribers" }}/{{ $sub.ID }}/lists" title="{{ range $i, $l := slice .ParsedLists 3 }}{{ if $i }}, {{ end }}{{ $l.Name }}{{ end }}">+{{ sub (len .ParsedLists) 3 }} {{ lower ($.L.T "globals.terms.lists") }}</a>
											{{- end }}
										</div>
									</div>
								</div>
							</td>
							<td class="name" data-label="{{ $.L.T "globals.fields.name" }}">
								<a class="unstyled" href="{{ URI "/admin/subscribers" }}/{{ .ID }}">{{ .Name }}</a>
							</td>
							<td data-label="{{ $.L.T "globals.fields.createdAt" }}">{{ NiceDate .CreatedAt }}</td>
							<td data-label="{{ $.L.T "globals.fields.updatedAt" }}">{{ NiceDate .UpdatedAt }}</td>
							<td class="actions align-right">
								<ot-dropdown>
									<button popovertarget="sub-actions-{{ .ID }}" type="button" class="ghost more icon" aria-label="{{ $.L.T "globals.buttons.more" }}">
										{{ Icon "more-vertical" }}
									</button>
									<menu popover id="sub-actions-{{ .ID }}">
										{{- if $d.Can "subscribers:manage" }}
										<a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/edit" role="menuitem" class="button ghost" data-testid="btn-edit">{{ Icon "edit-2" }} {{ $.L.T "globals.buttons.edit" }}</a>
										{{- end }}
										<hr />
										<a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/lists" role="menuitem" class="button ghost">{{ Icon "list" }} {{ $.L.Tc "globals.terms.lists" 2 }}</a>
										<a href="{{ URI "/admin/subscribers" }}/{{ .ID }}" role="menuitem" class="button ghost">{{ Icon "activity" }} {{ $.L.T "globals.terms.activity" }}</a>
										{{- if $d.Can "bounces:get" }}
										<a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/bounces" role="menuitem" class="button ghost">{{ Icon "corner-right-down" }} {{ $.L.T "globals.terms.bounces" }}</a>
										{{- end }}
										{{- if $d.Can "subscribers:manage" }}
											<a href="{{ URI "/api/subscribers" }}/{{ .ID }}/export" role="menuitem" class="button ghost" data-testid="btn-download">{{ Icon "download-cloud" }} {{ $.L.T "globals.buttons.downloadData" }}</a>
											<hr />
											<button type="button" role="menuitem" class="ghost" data-variant="danger" data-testid="btn-delete" :disabled="isLoading('subscribers')" @click.prevent="onDeleteSubscriber({{ .ID }}, {{ ToJSON .Email }})">{{ Icon "trash-2" }} {{ $.L.T "globals.buttons.delete" }}</button>
										{{- end }}
									</menu>
								</ot-dropdown>
							</td>
						</tr>
					{{- else }}
						{{ template "empty-state" 7 }}
					{{- end }}
				</tbody>
			</table>

			{{- template "pagination" $d.Page.Pagination }}
		</div>
	</div>

	<dialog x-ref="listDialog">
		<form @submit.prevent="onSubmitManageLists">
			<div class="dialog-card content">
				<header class="dialog-head"><h4 class="dialog-title">{{ .L.T "subscribers.manageLists" }}</h4></header>
				<section class="dialog-body">
					{{ template "manage-lists-form" dict "Root" . "Model" "bulk" "ListID" "bulk-lists" }}
				</section>
				<footer class="dialog-foot hstack gap-3 justify-end">
					<button type="button" class="outline" @click="$refs.listDialog.close()">{{ .L.T "globals.buttons.close" }}</button>
					<button type="submit" data-variant="primary" :disabled="bulk.lists.length === 0">{{ .L.T "globals.buttons.save" }}</button>
				</footer>
			</div>
		</form>
	</dialog>
</section>

<script type="module" src="{{ URI "/admin/static/js/views/subscribers.js" }}?v={{ .AssetVersion }}" defer></script>

{{ template "admin-footer" . -}}
{{ end }}