Add about and website fields to the Nostr profile editor
CI / Test (pull_request) Successful in 46s

The profile editor only covered display name, NIP-05 and Lightning address. Add the bio (`about`) and `website` fields, read from the existing profile and written back on save (with `website` validated as an http(s) URL).

Lay the form out in a responsive two-column grid (single column on mobile) and align the submit button with the other account settings forms. Also fix the avatar size utility (`size:28` -> `size-28`), which left the avatar unsized on small screens and let it overlap the display-name label.

Avatar and banner image editing is still to come.
This commit is contained in:
raucao committed 2026-11-19 17:49:21 +04:00
1 parent 12c99c9d5a
commit 4d2e0aa2b6
5 files changed
+197 -138

No files matched your search

@@ -1,13 +1,13 @@
<div class="w-[72vw] md:w-[500px]">
<div class="w-[72vw] md:w-[640px] lg:w-[760px]">
<header class="absolute z-10 h-36 sm:h-44 inset-x-1 top-1 rounded-t
bg-cover bg-center bg-gray-50"
style="<%= "background-image: url('#{banner_url}');" if banner_url %>">
<div class="inline-block z-20 size-28 sm:size-32 ml-4 mt-16 sm:mt-20">
<% if picture_url.present? %>
<img src="<%= picture_url %>"
class="inline-block size:28 sm:size-32 rounded-full border-2 border-white" />
class="inline-block size-28 sm:size-32 rounded-full border-2 border-white" />
<% else %>
<span class="inline-block size:28 sm:size-32 overflow-hidden rounded-full border-2 border-white bg-gray-100">
<span class="inline-block size-28 sm:size-32 overflow-hidden rounded-full border-2 border-white bg-gray-100">
<svg class="size-full text-gray-300" fill="currentColor" viewBox="0 0 24 24">
<path d="M24 20.993V24H0v-2.996A14.977 14.977 0 0112.004 15c4.904 0 9.26 2.354 11.996 5.993zM16.002 8.999a4 4 0 11-8 0 4 4 0 018 0z" />
</svg>
@@ -26,132 +26,146 @@
:'nostr-profile-editor-display-name-keys-value' => NostrManagerService::DISPLAY_NAME_KEYS.to_json
}
}) do |f| %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Display name") do %>
<%= f.text_field :display_name, value: @display_name, class: "w-full sm:w-3/5" %>
<% end %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Nostr address (NIP-05)") do %>
<% if @nip05_state[:status] == :added %>
<div class="w-full sm:w-3/5 flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @user.address %>">
<div class="relative">
<%= f.text_field :nip05_address, value: @nip05_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-16 border-emerald-500 ring-1 ring-emerald-500 focus:border-emerald-500 focus:ring-emerald-500 bg-emerald-50/20" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-emerald-100 px-2 py-0.5 text-xs font-semibold text-emerald-800">
added
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200 hidden"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @user.address %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @user.address %>">
Use this
</button>
</div>
</div>
<% elsif @nip05_state[:status] == :different %>
<div class="w-full sm:w-3/5 flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @nip05_state[:suggested] %>">
<div class="relative">
<%= f.text_field :nip05_address, value: @nip05_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-20 border-amber-400 ring-1 ring-amber-400 focus:border-amber-400 focus:ring-amber-400" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-amber-100 px-2 py-0.5 text-xs font-semibold text-amber-800">
different
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @nip05_state[:suggested] %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @nip05_state[:suggested] %>">
Use this
</button>
</div>
</div>
<% else %>
<%= f.text_field :nip05_address, value: @nip05_state[:value], class: "w-full sm:w-3/5" %>
<% end %>
<% end %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Lightning address for Zaps") do %>
<% if @lud16_state[:status] == :added %>
<div class="w-full sm:w-3/5 flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @user.address %>">
<div class="relative">
<%= f.text_field :lud16_address, value: @lud16_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-16 border-emerald-500 ring-1 ring-emerald-500 focus:border-emerald-500 focus:ring-emerald-500 bg-emerald-50/20" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-emerald-100 px-2 py-0.5 text-xs font-semibold text-emerald-800">
added
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200 hidden"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @user.address %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @user.address %>">
Use this
</button>
</div>
</div>
<% elsif @lud16_state[:status] == :different %>
<div class="w-full sm:w-3/5 flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @lud16_state[:suggested] %>">
<div class="relative">
<%= f.text_field :lud16_address, value: @lud16_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-20 border-amber-400 ring-1 ring-amber-400 focus:border-amber-400 focus:ring-amber-400" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-amber-100 px-2 py-0.5 text-xs font-semibold text-amber-800">
different
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @lud16_state[:suggested] %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @lud16_state[:suggested] %>">
Use this
</button>
</div>
</div>
<% else %>
<%= f.text_field :lud16_address, value: @lud16_state[:value], class: "w-full sm:w-3/5" %>
<% end %>
<% end %>
<div class="grid grid-cols-1 gap-y-6 md:grid-cols-2 md:gap-x-8">
<div>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Display name") do %>
<%= f.text_field :display_name, value: @display_name, class: "w-full" %>
<% end %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "About") do %>
<%= f.text_area :about, value: @about, rows: 3, class: "w-full" %>
<% end %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Website") do %>
<%= f.text_field :website, value: @website, class: "w-full",
placeholder: "https://example.com" %>
<% end %>
</div>
<div>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Nostr address (NIP-05)") do %>
<% if @nip05_state[:status] == :added %>
<div class="w-full flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @user.address %>">
<div class="relative">
<%= f.text_field :nip05_address, value: @nip05_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-16 border-emerald-500 ring-1 ring-emerald-500 focus:border-emerald-500 focus:ring-emerald-500 bg-emerald-50/20" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-emerald-100 px-2 py-0.5 text-xs font-semibold text-emerald-800">
added
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200 hidden"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @user.address %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @user.address %>">
Use this
</button>
</div>
</div>
<% elsif @nip05_state[:status] == :different %>
<div class="w-full flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @nip05_state[:suggested] %>">
<div class="relative">
<%= f.text_field :nip05_address, value: @nip05_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-20 border-amber-400 ring-1 ring-amber-400 focus:border-amber-400 focus:ring-amber-400" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-amber-100 px-2 py-0.5 text-xs font-semibold text-amber-800">
different
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @nip05_state[:suggested] %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @nip05_state[:suggested] %>">
Use this
</button>
</div>
</div>
<% else %>
<%= f.text_field :nip05_address, value: @nip05_state[:value], class: "w-full" %>
<% end %>
<% end %>
<%= render FormElements::FieldsetComponent.new(tag: "div", title: "Lightning address for Zaps") do %>
<% if @lud16_state[:status] == :added %>
<div class="w-full flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @user.address %>">
<div class="relative">
<%= f.text_field :lud16_address, value: @lud16_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-16 border-emerald-500 ring-1 ring-emerald-500 focus:border-emerald-500 focus:ring-emerald-500 bg-emerald-50/20" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-emerald-100 px-2 py-0.5 text-xs font-semibold text-emerald-800">
added
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200 hidden"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @user.address %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @user.address %>">
Use this
</button>
</div>
</div>
<% elsif @lud16_state[:status] == :different %>
<div class="w-full flex flex-col" data-controller="field-suggestion"
data-field-suggestion-added-value-value="<%= @lud16_state[:suggested] %>">
<div class="relative">
<%= f.text_field :lud16_address, value: @lud16_state[:value],
data: {
:'field-suggestion-target' => "input",
action: "input->field-suggestion#checkAdded"
},
class: "w-full pr-20 border-amber-400 ring-1 ring-amber-400 focus:border-amber-400 focus:ring-amber-400" %>
<span class="absolute inset-y-0 right-2.5 flex items-center pointer-events-none"
data-field-suggestion-target="badge">
<span class="rounded-full bg-amber-100 px-2 py-0.5 text-xs font-semibold text-amber-800">
different
</span>
</span>
</div>
<div class="mt-1.5 flex items-center justify-between text-xs text-amber-800 bg-amber-50 rounded px-2.5 py-1.5 border border-amber-200"
data-field-suggestion-target="suggestion">
<span>Account address: <strong><%= @lud16_state[:suggested] %></strong></span>
<button type="button" class="font-semibold text-blue-600 hover:text-blue-800 underline ml-2"
data-action="click->field-suggestion#apply"
data-field-suggestion-value-param="<%= @lud16_state[:suggested] %>">
Use this
</button>
</div>
</div>
<% else %>
<%= f.text_field :lud16_address, value: @lud16_state[:value], class: "w-full" %>
<% end %>
<% end %>
</div>
</div>
<p class="error-msg mt-2 hidden" data-nostr-profile-editor-target="error"></p>
<p class="mt-8">
<%= f.submit "Save profile", class: "btn-md btn-blue w-full",
<p class="mt-8 pt-6 border-t border-gray-200 text-right">
<%= f.submit "Save profile", class: "btn-md btn-blue w-full md:w-auto",
data: { :'nostr-profile-editor-target' => "submit" } %>
</p>
<% end %>
@@ -2,7 +2,8 @@
module Settings
class NostrEditProfileComponent < ViewComponent::Base
attr_reader :user, :profile, :profile_event, :display_name, :nip05_state, :lud16_state
attr_reader :user, :profile, :profile_event, :display_name, :nip05_state, :lud16_state,
:about, :website
def initialize(user:, profile_event: nil)
@user = user
@@ -18,6 +19,9 @@ module Settings
.map { |key| @profile[key] }
.find(&:present?) || @user.display_name
@about = @profile["about"] if @profile["about"].is_a?(String)
@website = @profile["website"] if @profile["website"].is_a?(String)
@nip05_state = compute_field_state(@profile["nip05"])
@lud16_state = compute_field_state(@profile["lud16"])
end
@@ -3,6 +3,7 @@ import { signAndPublish, hasNostrExtension } from "lib/nostr_publish"
const PROFILE_KIND = 0
const ADDRESS_PATTERN = /^[^@\s]+@[^@\s]+\.[^@\s]+$/
const URL_PATTERN = /^https?:\/\/\S+$/i
export default class extends Controller {
static targets = [ "error", "submit" ]
@@ -16,9 +17,9 @@ export default class extends Controller {
event.preventDefault()
this.clearError()
const displayName = this.field("display_name")
const nip05 = this.field("nip05_address")
const lud16 = this.field("lud16_address")
const website = this.field("website")
if (nip05 && !ADDRESS_PATTERN.test(nip05)) {
this.showError("Please enter a valid NIP-05 address, e.g. name@example.com.")
@@ -28,6 +29,10 @@ export default class extends Controller {
this.showError("Please enter a valid Lightning address, e.g. name@example.com.")
return
}
if (website && !URL_PATTERN.test(website)) {
this.showError("Please enter a valid website URL, e.g. https://example.com.")
return
}
if (!hasNostrExtension()) {
this.showError("No Nostr extension (NIP-07) found.")
return
@@ -40,7 +45,7 @@ export default class extends Controller {
kind: PROFILE_KIND,
created_at: Math.floor(Date.now() / 1000),
tags: [],
content: JSON.stringify(this.content(displayName, nip05, lud16))
content: JSON.stringify(this.content())
})
this.element.dispatchEvent(new CustomEvent("nostr:publish", {
bubbles: true,
@@ -53,12 +58,15 @@ export default class extends Controller {
}
}
content (displayName, nip05, lud16) {
content () {
const content = { ...(this.profileValue || {}) }
const displayName = this.field("display_name")
this.displayNameKeysValue.forEach((key) => this.assign(content, key, displayName))
this.assign(content, "nip05", nip05)
this.assign(content, "lud16", lud16)
this.assign(content, "nip05", this.field("nip05_address"))
this.assign(content, "lud16", this.field("lud16_address"))
this.assign(content, "about", this.field("about"))
this.assign(content, "website", this.field("website"))
if (!content.name && this.handleValue) {
content.name = this.handleValue
+4 -4
View File
@@ -64,10 +64,10 @@ it to your local strfry for example:
The account settings page lets users publish their own Nostr data:
* **Profile** (kind `0`) — display name, NIP-05 address and Lightning address. Edited fields are
merged into the existing profile JSON, so unknown keys (`about`, `picture`, …) are preserved.
The display name is read from the first present of `display_name`, `displayName`, `name` or
`username`, and written to all of them for maximum client compatibility.
* **Profile** (kind `0`) — display name, about, website, NIP-05 address and Lightning address.
Edited fields are merged into the existing profile JSON, so unknown keys (`picture`, `banner`, …)
are preserved. The display name is read from the first present of `display_name`, `displayName`,
`name` or `username`, and written to all of them for maximum client compatibility.
* **Relay list** (NIP-65, kind `10002`) — the site relay is pre-included; entries can be marked
read-only or write-only.
* **Media server list** (Blossom, kind `10063`) — the configured Blossom server is pre-included.
@@ -78,13 +78,46 @@ RSpec.describe Settings::NostrEditProfileComponent, type: :component do
it "passes the existing profile to the editor so unknown keys survive" do
profile_event = {
"content" => { "about" => "hi", "nip05" => "alice@kosmos.org" }.to_json
"content" => { "picture" => "https://example.com/p.png", "nip05" => "alice@kosmos.org" }.to_json
}
rendered = render_inline(described_class.new(user: user, profile_event: profile_event))
form = rendered.css("form").first
profile = JSON.parse(form["data-nostr-profile-editor-profile-value"])
expect(profile).to eq("about" => "hi", "nip05" => "alice@kosmos.org")
expect(profile).to eq("picture" => "https://example.com/p.png", "nip05" => "alice@kosmos.org")
end
describe "about and website fields" do
it "prefills them from the profile" do
profile_event = {
"content" => {
"about" => "Hello there",
"website" => "https://alice.example.com"
}.to_json
}
rendered = render_inline(described_class.new(user: user, profile_event: profile_event))
expect(rendered.css("textarea[name='user[about]']").first.text).to eq("Hello there")
expect(rendered.css("input[name='user[website]']").first["value"])
.to eq("https://alice.example.com")
end
it "renders them blank when absent" do
rendered = render_inline(described_class.new(user: user, profile_event: nil))
expect(rendered.css("textarea[name='user[about]']").first.text).to be_blank
expect(rendered.css("input[name='user[website]']").first["value"]).to be_blank
end
it "ignores non-string values" do
profile_event = {
"content" => { "about" => 42, "website" => ["https://x.example.com"] }.to_json
}
rendered = render_inline(described_class.new(user: user, profile_event: profile_event))
expect(rendered.css("textarea[name='user[about]']").first.text).to be_blank
expect(rendered.css("input[name='user[website]']").first["value"]).to be_blank
end
end
describe "image URL sanitization" do