Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
f1a16e8
initialize content and assets
slax57 Aug 21, 2025
572a078
update recipes
slax57 Aug 21, 2025
45a51fd
update other (mostly)
slax57 Aug 21, 2025
22c4b2e
update i18n
slax57 Aug 22, 2025
d4556ff
update preferences
slax57 Aug 22, 2025
a2dffea
update inputs (mostly)
slax57 Aug 22, 2025
8eea15a
update fields
slax57 Aug 22, 2025
4573871
update common
slax57 Aug 22, 2025
fb73b7c
update show
slax57 Aug 22, 2025
68e64d4
update create-edit
slax57 Aug 25, 2025
a6c7bec
update app-configuration
slax57 Aug 25, 2025
e11024e
simplify CoreAdmin usage
slax57 Aug 25, 2025
bfcdcd7
update security (wip)
slax57 Aug 26, 2025
9df700f
Update deploy-doc-headless.yml workflow triggers
slax57 Aug 26, 2025
1c98b3d
update list (wip)
slax57 Aug 26, 2025
9b812a8
update security (end)
slax57 Aug 27, 2025
5685546
update list (part 2)
slax57 Aug 27, 2025
3b1e3fb
update list (end)
slax57 Aug 27, 2025
171b75d
update features
slax57 Aug 29, 2025
78725c9
update data-fetching (wip)
slax57 Aug 29, 2025
e2b3d36
update data-fecthing (end)
slax57 Sep 1, 2025
ee2049d
update guides (wip)
slax57 Sep 1, 2025
1c6a2e9
update guides (end)
slax57 Sep 2, 2025
7a3bedb
fix ReferenceInput usage in useUnique
slax57 Sep 2, 2025
23ff1ee
improve props table layout
slax57 Sep 2, 2025
ab16d69
update title from 'React Admin Headless' to 'ra-core' in config files
slax57 Sep 2, 2025
581f966
improve sidebar order and labels
slax57 Sep 2, 2025
feca680
add missing assets to public/img
slax57 Sep 2, 2025
d5a8ab9
update assets source paths
slax57 Sep 2, 2025
19ec28a
clean up unused assets
slax57 Sep 2, 2025
6e04a28
Merge branch 'master' into merge-master-5.11.0
slax57 Sep 3, 2025
704ad2c
Merge pull request #10912 from marmelab/merge-master-5.11.0
slax57 Sep 3, 2025
3f5bb81
Merge remote-tracking branch 'origin/next' into headless-doc-content
slax57 Sep 3, 2025
5b98878
add getting started guide
slax57 Sep 3, 2025
20ebc74
clean up more assets
slax57 Sep 3, 2025
1030a5e
remove ReferenceInputBase, ReferenceArrayInputBase and useCheckForApp…
slax57 Sep 3, 2025
270dfd3
fix missing trailing slash on internal links
slax57 Sep 3, 2025
48b6b5a
improve landing page
slax57 Sep 3, 2025
ef50c26
fix: update RecordType definition in ReferenceFieldBaseProps for bett…
slax57 Sep 3, 2025
6f3f824
flatten file structure
slax57 Sep 4, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/ReferenceFieldBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ It uses `dataProvider.getMany()` instead of `dataProvider.getOne()` [for perform
| `empty` | Optional | `ReactNode` | - | What to render when the field has no value or when the reference is missing |
| `offline` | Optional | `ReactNode` | - | What to render when there is no network connectivity when loading the record |
| `queryOptions` | Optional | [`UseQuery Options`](https://tanstack.com/query/v5/docs/react/reference/useQuery) | `{}` | `react-query` client options |
| `record` | Optional | `RaRecord` | - | The current record |
| `sortBy` | Optional | `string | Function` | `source` | Name of the field to use for sorting when used in a Datagrid |

## `children`
Expand Down
185 changes: 159 additions & 26 deletions docs_headless/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import rehypeAstroRelativeMarkdownLinks from 'astro-rehype-relative-markdown-lin
export default defineConfig({
integrations: [
starlight({
title: 'React Admin Headless',
title: 'ra-core',
customCss: ['./src/styles/global.css'],
favicon: '/favicon.ico',
social: [
Expand All @@ -25,37 +25,169 @@ export default defineConfig({
},
],
sidebar: [
{
label: 'Getting Started',
slug: 'getting-started',
},
{
label: 'Guides & Concepts',
items: [
// Each item here is one entry in the navigation menu.
{
label: 'General Concepts',
slug: 'guides/architecture',
},
{
label: 'Data Fetching',
slug: 'guides/datafetchingguide',
},
{
label: 'CRUD pages',
slug: 'guides/crud',
attrs: {
class: 'flex items-center',
},
badge: {
text: '',
variant: 'default',
class: 'ee-badge',
},
},
'architecture',
'datafetchingguide',
'crud',
'forms',
'securityguide',
'routing',
'translation',
'store',
'features',
],
},
{
label: 'App Configuration',
items: ['coreadmin', 'resource', 'customroutes'],
},
{
label: 'Data Fetching',
items: [
'dataproviders',
'actions',
'dataproviderlist',
'dataproviderwriting',
'fetchjson',
'usecreate',
'usedataprovider',
'usedelete',
'usedeletemany',
'usegetlist',
'usegetmany',
'usegetmanyreference',
'usegetone',
'useinfinitegetlist',
'useupdate',
'useupdatemany',
'withlifecyclecallbacks',
],
},
{
label: 'Security',
items: [
'authentication',
'authproviderlist',
'authproviderwriting',
'permissions',
'authenticated',
'canaccess',
'useauthenticated',
'useauthprovider',
'useauthstate',
'usecanaccess',
'usegetidentity',
'uselogin',
'uselogout',
'usepermissions',
'addrefreshauthtoauthprovider',
'addrefreshauthtodataprovider',
],
},
{
label: 'List Page',
items: [
'listtutorial',
'filteringtutorial',
'listbase',
'infinitelistbase',
'listiterator',
'filterliveform',
'withlistcontext',
'uselist',
'uselistcontext',
'uselistcontroller',
'useunselect',
'useunselectall',
],
},
{
label: 'Creation & Edition Pages',
items: [
'edittutorial',
'validation',
'createbase',
'editbase',
'form',
'usecreatecontext',
'usecreatecontroller',
'useeditcontext',
'useeditcontroller',
'userecordfromlocation',
'useregistermutationmiddleware',
'usesavecontext',
'useunique',
],
},
{
label: 'Show Page',
items: ['showbase', 'useshowcontext', 'useshowcontroller'],
},
{
label: 'Common',
items: [
'withrecord',
'usegetrecordid',
'usenotify',
'userecordcontext',
'useredirect',
'userefresh',
],
},
{
label: 'Fields',
items: [
'fields',
'fieldsforrelationships',
'referencearrayfieldbase',
'referencefieldbase',
'referencemanycountbase',
'referencemanyfieldbase',
'referenceonefieldbase',
'usefieldvalue',
],
},
{
label: 'Inputs',
items: ['inputs', 'useinput'],
},
{
label: 'Preferences',
items: [
'usestore',
'useremovefromstore',
'useresetstore',
'usestorecontext',
],
},
{
label: 'I18N Provider & Translations',
items: [
'translationsetup',
'translationlocales',
'translationtranslating',
'translationwriting',
'translate',
'uselocalestate',
'usetranslate',
],
},
{
label: 'Other Components & Hooks',
items: [
'recordrepresentation',
'usegetrecordrepresentation',
],
},
{
label: 'Reference',
autogenerate: {
directory: 'reference',
},
label: 'Recipes',
items: ['caching', 'unittesting'],
},
],
components: {
Expand All @@ -76,6 +208,7 @@ export default defineConfig({
{
base: '/ra-core/',
collectionBase: false,
trailingSlash: 'always',
},
],
],
Expand Down
Binary file added docs_headless/public/img/AccessControl.mp4
Binary file not shown.
Binary file added docs_headless/public/img/AutoRefresh.mp4
Binary file not shown.
Binary file added docs_headless/public/img/FilterLiveForm.mp4
Binary file not shown.
Binary file added docs_headless/public/img/LocalesMenuButton.mp4
Binary file not shown.
Binary file added docs_headless/public/img/LocalesMenuButton.webm
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs_headless/public/img/filter_with_submit.mp4
Binary file not shown.
Binary file added docs_headless/public/img/filter_with_submit.webm
Binary file not shown.
Binary file added docs_headless/public/img/infinite-book-list.webm
Binary file not shown.
Binary file added docs_headless/public/img/login.mp4
Binary file not shown.
Binary file added docs_headless/public/img/logout.mp4
Binary file not shown.
Binary file added docs_headless/public/img/ra-rbac.mp4
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs_headless/public/img/reference-input.mp4
Binary file not shown.
Binary file added docs_headless/public/img/reference-input.webm
Binary file not shown.
Binary file added docs_headless/public/img/translation.mp4
Binary file not shown.
Binary file added docs_headless/public/img/translation.webm
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs_headless/public/img/typescript.mp4
Binary file not shown.
Binary file added docs_headless/public/img/typescript.webm
Binary file not shown.
Binary file added docs_headless/public/img/useInfiniteGetList.mp4
Binary file not shown.
Binary file added docs_headless/public/img/useInfiniteGetList.webm
Binary file not shown.
Binary file added docs_headless/public/img/useUnique.mp4
Binary file not shown.
Binary file added docs_headless/public/img/useUnique.webm
Binary file not shown.
Binary file removed docs_headless/src/assets/tutorial_guessed_list.png
Binary file not shown.
Loading
Loading