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

adjusted documentation for the linkType property found in SimpleList and SingleFieldList #8171

Merged
merged 6 commits into from
Sep 16, 2022

Conversation

riexn
Copy link
Contributor

@riexn riexn commented Sep 16, 2022

There used to be documentation on the possible options with linkType, but this is from an old PR and that part of the documentation changed with time since it's no longer a property in ReferenceField.

I have added documentation for the following options for linkType:

  • "show"
  • "edit"
  • false

Though I did not add documentation for the empty string option "", because it has inconsistent behavior with false when used in SimpleList:

  • "" would not route to other pages, but the buttons will still be clickable.
  • false would not route to other pages, and the buttons will not be clickable.

…the possible options for the property linkType
docs/SimpleList.md Outdated Show resolved Hide resolved
docs/SingleFieldList.md Outdated Show resolved Hide resolved
…Fixed the wording in SingleFieldList docs because the previous one was meant for the reference field.
Copy link
Member

@fzaninotto fzaninotto left a comment

Choose a reason for hiding this comment

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

Thanks! I've suggested a few edits.

docs/SimpleList.md Outdated Show resolved Hide resolved
docs/SimpleList.md Outdated Show resolved Hide resolved
docs/SingleFieldList.md Outdated Show resolved Hide resolved
docs/SingleFieldList.md Outdated Show resolved Hide resolved
riexn and others added 4 commits September 16, 2022 16:04
Co-authored-by: Francois Zaninotto <fzaninotto@gmail.com>
Co-authored-by: Francois Zaninotto <fzaninotto@gmail.com>
Co-authored-by: Francois Zaninotto <fzaninotto@gmail.com>
Co-authored-by: Francois Zaninotto <fzaninotto@gmail.com>
@fzaninotto
Copy link
Member

Thanks!

@fzaninotto fzaninotto modified the milestones: 4.4.0, 4.3.4 Sep 16, 2022
@riexn
Copy link
Contributor Author

riexn commented Sep 16, 2022

Thanks!

Welcome!

@riexn riexn deleted the docs-linktype-fix branch September 17, 2022 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants