Update docs and upgrade guide

Author: Flo0807

guides/fields/readonly.md

@@ -1,14 +1,14 @@
 # Readonly
 
-Fields can be configured to be readonly. In edit view, these fields are rendered with the additional HTML attributes `readonly` and `disabled`, ensuring that the user cannot interact with the field or change its value.
+Fields can be configured to be readonly. In edit view, these fields are rendered with the additional HTML attributes `readonly` and `disabled`, ensuring that users cannot interact with the field or change its value.
 
-In index view, if readonly and index editable is set to `true`, forms will be rendered with the `readonly` HTML attribute.
+In index view, if readonly and index editable are both set to true, forms will be rendered with the `readonly` HTML attribute.
 
 ## Supported fields
 
-On index view, read-only is supported for all fields with the index editable option (see [Index Edit](index-edit.md)).
+On index view, readonly is supported for all fields with the index editable option (see [Index Edit](index-edit.md)).
 
-On edit view, read-only is supported for:
+On edit view, readonly is supported for:
 - `Backpex.Fields.Date`
 - `Backpex.Fields.DateTime`
 - `Backpex.Fields.Number`
@@ -17,19 +17,19 @@ On edit view, read-only is supported for:
 
 ## Configuration
 
-To enable read-only for a field, you need to set the `readonly` option to `true` in the field configuration. This key must contain either a boolean value or a function that returns a boolean value.
+To enable readonly for a field, you need to set the `readonly` option to true in the field configuration. This key must contain either a boolean value or a function that returns a boolean value.
 
 ```elixir
 # in your resource configuration file
 def fields do
 [
-    rating: %{
-        module: Backpex.Fields.Text,
-        label: "Rating",
-        readonly: fn assigns ->
-            assigns.current_user.role in [:employee]
-        end
-    }
+  rating: %{
+    module: Backpex.Fields.Text,
+    label: "Rating",
+    readonly: fn assigns ->
+        assigns.current_user.role in [:employee]
+    end
+  }
 ]
 end
 ```
@@ -38,41 +38,54 @@ end
 # in your resource configuration file
 def fields do
 [
-    rating: %{
-        module: Backpex.Fields.Text,
-        label: "Rating",
-        readonly: true
-    }
+  rating: %{
+    module: Backpex.Fields.Text,
+    label: "Rating",
+    readonly: true
+  }
 ]
 end
 ```
 
 ## Readonly for custom fields
 
-You can also add readonly functionality to a custom field. To do this, you need to define a [`render_form_readonly/1`](Backpex.Field.html#c:render_form_readonly/1) function. This function must return markup to be used when readonly is enabled.
+You can also add readonly functionality to a custom field. To do this, you need to handle the readonly state in the `c:Backpex.Field.render_form/1` function of your custom field. You can access the readonly value from the assigns, which will be `true` or `false`.
 
 ```elixir
 @impl Backpex.Field
-def render_form_readonly(assigns) do
+def render_form(assigns) do
 ~H"""
 <div>
-    <Layout.field_container>
-        <:label>
-            <Layout.input_label text={@field[:label]} />
-        </:label>
-        <BackpexForm.input
-        type="text"
-        field={@form[@name]}
-        translate_error_fun={Backpex.Field.translate_error_fun(@field_options, assigns)}
-        phx-debounce={Backpex.Field.debounce(@field_options, assigns)}
-        phx-throttle={Backpex.Field.throttle(@field_options, assigns)}
-        readonly
-        disabled
-        />
-    </Layout.field_container>
+  <Layout.field_container>
+    <:label>
+        <Layout.input_label text={@field[:label]} />
+    </:label>
+    <BackpexForm.input
+      type="text"
+      field={@form[@name]}
+      translate_error_fun={Backpex.Field.translate_error_fun(@field_options, assigns)}
+      phx-debounce={Backpex.Field.debounce(@field_options, assigns)}
+      phx-throttle={Backpex.Field.throttle(@field_options, assigns)}
+      readonly={@readonly}
+      disabled={@readonly}
+    />
+  </Layout.field_container>
 </div>
 """
 end
 ```
 
-When defining a custom field with index editable support, you need to handle the readonly state in the index editable markup. There is a `readonly` value in the assigns, which will be `true` or `false`.
+If your readonly logic is more complex, you can also use a dedicated function that returns the markup for the readonly state.
+
+```elixir
+@impl Backpex.Field
+def render_form(%{readonly: true} = assigns) do
+# Return readonly markup
+end
+
+def render_form(%{readonly: false} = assigns) do
+# Return editable markup
+end
+```
+
+When defining a custom field with index editable support, you need to handle the readonly state in `c:Backpex.Field.render_index_form/1`. There is also a readonly value in the assigns, which will be `true` or `false`.

guides/upgrading/v0.14.md

@@ -81,3 +81,22 @@ def changeset(change, attrs, _metadata) do
   |> Ecto.Changeset.validate_required([:field1])
 end
 ```
+
+## `render_form_readonly/1` callback has been removed
+
+We removed the `render_form_readonly/1` callback from fields. Instead, `readonly` must be handled directly in the `c:Backpex.Field.render_form/1` callback.
+
+Make sure to update your custom fields accordingly. The `readonly` value will be available in the assigns, which will be `true` or `false`.
+
+```elixir
+@impl Backpex.Field
+def render_form(%{readonly: true} = assigns) do
+# render readonly field
+end
+
+def render_form(%{readonly: false} = assigns) do
+# render editable field
+end
+```
+
+See the [Readonly guide](readonly.md) for more details.