Skip to content

Commit

Permalink
Soft deprecate Link
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagoefmoraes committed Apr 9, 2024
1 parent a68f98c commit aa5c6ae
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

This version moves all Form helpers to a [separate library](https://github.com/surface-ui/surface_form). Form Helpers are no longer used in new apps from Surface v0.12. Older applications who wish to maintain compatibility, add `{:surface_form, "~> 0.1.0"}` to your `mix.exs`.

## v0.11.3 (yyyy-mm-dd)

* Restrict phoenix_live_view version up to `0.20.9` due to compatibility
issues introduced by phoenix_live_view `0.20.10` regarding debug annotations.

### Soft Deprecations

* `Link` has been deprecated in favor of liveview's built-in `<.link>`.
See <https://hexdocs.pm/phoenix_live_view/live-navigation.html> for more info.

## v0.11.2 (2024-02-19)

* Add support for Liveview >= `v0.20` (#714)
Expand Down
8 changes: 8 additions & 0 deletions lib/surface/components/link.ex
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
defmodule Surface.Components.Link do
@moduledoc """
> #### Soft deprecation warning {: .warning}
>
> This component has been deprecated in favor of liveview's built-in `<.link>`
> and will be removed in `v0.13`. See https://hexdocs.pm/phoenix_live_view/live-navigation.html for
> more info usage.
Generates a link to the given URL.
Provides similar capabilities to Phoenix's built-in `link/2` function.
Expand All @@ -26,6 +32,8 @@ defmodule Surface.Components.Link do
```
"""

@moduledoc deprecated: "Use liveview's built-in `<.link>` instead"

use Surface.Component
use Surface.Components.Events

Expand Down

0 comments on commit aa5c6ae

Please sign in to comment.