docs: added example in docs of using a resolver for metatags for markdown component (#1014) #1082
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
✅ Deploy Preview for analog-ng-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-blog ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
brandonroberts
requested changes
May 6, 2024
| @@ -161,6 +161,70 @@ export default class BlogPostComponent { | |||
| } | |||
| ``` | |||
|
|
|||
| ### Using A Resolver For Metatags | |||
|
|
|||
| The `postMetaResolver` function is responsible for fetching the meta tags for a post. This function should return an array of meta tags. Here's an example: | |||
There was a problem hiding this comment.
Suggested change
| The `postMetaResolver` function is responsible for fetching the meta tags for a post. This function should return an array of meta tags. Here's an example: | |
| In your route configuration, you can use the `RouteMeta` object to resolve meta tags for a route. This is done by assigning the `postMetaResolver` function to the `meta` property. | |
| Below is an example of using a `postMetaResolver` function that fetches the meta tags for a post. This function returns an array of meta tags. |
| }; | ||
| ``` | ||
|
|
||
| In your route configuration, you can use the `RouteMeta` object to resolve meta tags for a route. This is done by assigning the `postMetaResolver` function to the `meta` property. Here's an example: |
There was a problem hiding this comment.
Suggested change
| In your route configuration, you can use the `RouteMeta` object to resolve meta tags for a route. This is done by assigning the `postMetaResolver` function to the `meta` property. Here's an example: | |
| The meta tags can be done asynchronously also. Assign the `postMetaResolver` function to the `meta` property. |
| }; | ||
| ``` | ||
|
|
||
| The resolved meta tags can be accessed in the `BlogPostComponent` using the `ActivatedRoute` service. These meta tags can then be passed to the `MarkdownComponent`. Here's an example: |
There was a problem hiding this comment.
The meta tags cannot be passed to the analog-markdown component, so maybe a different component name that needs to be used here.
Suggested change
| The resolved meta tags can be accessed in the `BlogPostComponent` using the `ActivatedRoute` service. These meta tags can then be passed to the `MarkdownComponent`. Here's an example: | |
| The resolved meta tags can also be accessed in the component using the `ActivatedRoute` service. |
| ```ts | ||
| export default class BlogPostComponent { | ||
| readonly route = inject(ActivatedRoute); | ||
| readonly metaTags$ = this.route.data.pipe(pluck('meta')); |
There was a problem hiding this comment.
Isn't pluck deprecated in RxJS?
Suggested change
| readonly metaTags$ = this.route.data.pipe(pluck('meta')); | |
| readonly metaTags$ = this.route.data.pipe(map(data => data['meta'])); |
| readonly metaTags$ = this.route.data.pipe(pluck('meta')); | ||
|
|
||
| // In the template | ||
| <analog-markdown [content]="post.content" [metaTags]="metaTags$ | async"></analog-markdown> |
There was a problem hiding this comment.
Suggested change
| <analog-markdown [content]="post.content" [metaTags]="metaTags$ | async"></analog-markdown> | |
| <my-component [metaTags]="metaTags$ | async"></my-component> |
| } | ||
| ``` | ||
|
|
||
| The `MarkdownComponent` should be modified to accept an input for meta tags and use these when rendering the markdown content. Here's an example: |
There was a problem hiding this comment.
I think this section should be removed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Which package are you modifying?
What is the current behavior?
Closes #1014
What is the new behavior?
A new Example added to the docs.
Does this PR introduce a breaking change?
Other information