Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Promote composition with <ListLiveUpdate> instead of <ListLive> #10531

Merged
merged 2 commits into from
Feb 21, 2025

Conversation

djhi
Copy link
Collaborator

@djhi djhi commented Feb 19, 2025

Problem

As <ListLive> is a simple wrapper around <List> that include <ListLiveUpdate>, we should promote using it.

Solution

Update the documentation accordingly.

Additional Checks

  • The PR targets master for a bugfix, or next for a feature
  • The documentation is up to date

Also, please make sure to read the contributing guidelines.

Copy link
Contributor

@slax57 slax57 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

otherwise lgtm!

@@ -39,7 +39,7 @@ This adapter subscribes to [Postgres Changes](https://supabase.com/docs/guides/r
```jsx
import { createClient } from '@supabase/supabase-js';
import { supabaseDataProvider } from 'ra-supabase';
import { addRealTimeMethodsBasedOnSupabase, ListLive } from '@react-admin/ra-realtime';
import { addRealTimeMethodsBasedOnSupabase, ListLiveUpdate } from '@react-admin/ra-realtime';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing import List from react-admin at line 43

@@ -123,7 +124,7 @@ import {
hydraDataProvider,
} from '@api-platform/admin';
import {
ListLive,
ListLiveUpdate,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same (at line 119)

@slax57 slax57 added this to the 5.6.1 milestone Feb 21, 2025
@slax57 slax57 merged commit c873665 into master Feb 21, 2025
16 checks passed
@slax57 slax57 deleted the doc-list-live-update branch February 21, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants