[docs] peregrine talons overview #1876
Conversation
jcalcaben
added
the
version: Minor
If your PR is missing information, check against the original template here. At a minimum you must have the section headers from the template and provide some information in each section. |
| Peregrine **talons** are designed to fulfill the logic needs of a single Venia UI component. | ||
| This means that each talon belongs to a specific UI component in Venia and is not used in any other Venia component. | ||
|
|
||
| For example, the functionality provided by the `useHeader()` talon is only relevant to the the `Header` component. |
There was a problem hiding this comment.
To expand on this section:
Going forward we may identify pieces of talons that perform identical functionality and that can be moved to a hook. We're being extra careful not to do that just yet because we don't want to create more API surface that we have to support (since this is so new) but we may do this in the future.
Take that as you will -- not sure if it's worth adding anything in here about that.
|
|
||
| Venia UI components use talons by default, so | ||
| developers can use Venia UI components as is without worrying about talons. | ||
| If developers want to change how a Venia UI component looks, they can import its associated talon into a new or modified UI component of the same type. |
There was a problem hiding this comment.
The extension/customization story isn't quite complete but maybe we want to show an example?
There was a problem hiding this comment.
I would rather wait until the story is complete before adding more information about it
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: review
labels
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
Description
Creates an unpublished doc topic about Peregrine talon. It is unpublished because talons are not currently available in 4.0.0.
Related Issue
Closes #1756
Acceptance
@jimbo
@sirugh
Verification Stakeholders
@jimbo
@sirugh
Verification Steps
pwa-devdocsdirectory:cd pwa-devdocsnpm run lint _drafts/talons/index.mdThis topic is not published so there is no need to do an HTML preview.
Screenshots / Screen Captures (if appropriate)
Checklist