This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
TS-ify use-load-more and use TS and defineComponent in layouts and pages #1473
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
obulat
added
🟩 priority: low
|
Storybook and Tailwind configuration previews: Ready Storybook: https://wordpress.github.io/openverse-frontend/1473 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
|
Size Change: +85 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
sarayourfriend
approved these changes
Jun 1, 2022
src/pages/search/audio.vue
Outdated
| @@ -72,8 +72,8 @@ export default defineComponent({ | |||
| focusFilters.focusFilterSidebar(event, Focus.Last) | |||
| } | |||
| } | |||
|
|
|||
| const { canLoadMore, onLoadMore } = useLoadMore(props) | |||
| const searchTermRef = computed(() => props.searchTerm) | |||
There was a problem hiding this comment.
FWIW you can also use toRef for this. I think it might convey the intention a little more clearly than compute:
Suggested change
| const searchTermRef = computed(() => props.searchTerm) | |
| const searchTermRef = toRef(props, 'searchTerm') |
There was a problem hiding this comment.
Thank you! I finally understood what toRef is used for! :)
src/pages/search/image.vue
Outdated
| @@ -25,7 +25,9 @@ export default defineComponent({ | |||
| useMeta({ title: `${props.searchTerm} | Openverse` }) | |||
|
|
|||
| const results = computed(() => props.resultItems.image) | |||
| const { canLoadMore, onLoadMore } = useLoadMore(props) | |||
|
|
|||
| const searchTermRef = computed(() => props.searchTerm) | |||
There was a problem hiding this comment.
Suggested change
| const searchTermRef = computed(() => props.searchTerm) | |
| const searchTermRef = toRef(props, 'searchTerm') |
src/pages/search/index.vue
Outdated
| @@ -17,7 +17,9 @@ export default defineComponent({ | |||
| setup(props) { | |||
| useMeta({ title: `${props.searchTerm} | Openverse` }) | |||
|
|
|||
| const { canLoadMore, onLoadMore } = useLoadMore(props) | |||
| const searchTermRef = computed(() => props.searchTerm) | |||
There was a problem hiding this comment.
Suggested change
| const searchTermRef = computed(() => props.searchTerm) | |
| const searchTermRef = toRef(props, 'searchTerm') |
krysal
reviewed
Jun 1, 2022
| @@ -72,7 +72,7 @@ | |||
| </VContentPage> | |||
| </template> | |||
|
|
|||
| <script> | |||
| <script lang="ts"> | |||
There was a problem hiding this comment.
Should we include this page and the others in the tsconfig.json file?
There was a problem hiding this comment.
Great question, @krysal !
If we include this page in tsconfig, then it will be typechecked. And if the types are incorrect, it will not build the app. And because we have some dependencies on Aria-kit that uses some React types internally, we cannot typecheck many of the pages/components that have popups or modals in them.
When we only add lang="ts", but do not add the files to tsconfig, we can use Typescript in the code, but type errors will not prevent the app from building. So, we can use the TS type annotations and declare types instead of using the JSDoc comments in these components. I feel it is easier to read the code when all components use the same type annotation style, you don't have to context-switch as much.
# Conflicts: # src/pages/index.vue
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Related to Typescriptification milestone
Description
This PR is extracted from #1405 to make it easier to review.
This PR refactors useLoadMore composable so that it's easier to see what arguments it expects.
It also adds
lang="ts"anddefineComponentto pages and layouts.Testing Instructions
Passing CI should be fine.
Checklist
Update index.md).main) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin