Skip to content

Requisition List Documentation#681

Merged
bdenham merged 39 commits intoreleases/b2b-nov-releasefrom
b2b-docs-requisition-list-v3
Jan 13, 2026
Merged

Requisition List Documentation#681
bdenham merged 39 commits intoreleases/b2b-nov-releasefrom
b2b-docs-requisition-list-v3

Conversation

@bdenham
Copy link
Copy Markdown
Collaborator

@bdenham bdenham commented Dec 18, 2025

Purpose of this pull request

This PR adds complete documentation for the Requisition List B2B drop-in.

Associated JIRA ticket

Part of #600 - B2B Documentation Initiative

Staging preview

Preview: https://commerce-docs.github.io/microsite-commerce-storefront/dropins-b2b/requisition-list/

Affected pages

New pages added:

  • Overview and Quick Start
  • Functions API reference
  • Events reference
  • Containers (5 containers with Diagram components and screenshots)
  • Slots reference
  • Styles and i18n dictionary
  • Initialization guide

Files changed (23 total)

  • 1 enrichment file (container parameter descriptions)
  • 14 documentation files
  • 8 UI screenshots

Links to source code

Not applicable - documentation only


Note: This is a clean PR containing ONLY Requisition List documentation files, replacing PR #668.

- Add complete documentation for all Requisition List containers
- Add container parameter enrichments with Diagram components
- Add 8 UI screenshots for visual reference
- Include all generated documentation (events, functions, initialization, etc.)
@bdenham bdenham added the new-topic A major update published as an entirely new document label Dec 18, 2025
@bdenham bdenham self-assigned this Dec 18, 2025
@bdenham bdenham requested review from keharper and svera December 18, 2025 18:35
- Change Slots order from 5 to 7 (was duplicate with Events)
- Add sidebar metadata to Styles (label and order: 9)
- Fixes broken sidebar navigation links
- Remove parameters from other B2B drop-ins (Purchase Order, Approval Rules)
- Remove generic container parameters (withHeader, withWrapper, className)
- Keep only Requisition List-specific parameters for each container
- Remove parameters from other B2B drop-ins
- Remove generic container parameters
- Keep only ariaLabel and onCompanyChange
- Latest validation scripts
- Updated generators
- Architectural documentation

# Conflicts:
#	_dropin-enrichments/company-switcher/containers.json
#	_dropin-enrichments/requisition-list/containers.json
@bdenham bdenham requested a review from dshevtsov as a code owner December 18, 2025 23:35
Updates requisition-list branch with:
- Programmatic safeguards (Git hooks, GitHub Actions)
- Publication workflow documentation
- Safety summaries and architecture docs
- Migration completion documentation

# Conflicts:
#	B2B-ARCHITECTURE-INDEX.md
#	B2B-WORKFLOW-GUIDE.md
#	DUAL-BRANCH-ARCHITECTURE.md
Feature branches now receive safeguard files (Git hooks, GitHub Actions,
publication docs) when merged from releases/b2b-nov-release.

The validation script needs to explicitly allow these files:
- .githooks/ directory
- .github/workflows/ (safeguard workflows)
- All .md files (includes PUBLISH-B2B-README.md, etc.)

This prevents false validation failures on feature branches.
Changed pattern from ^\.github/workflows/ to ^\.github/
to include files like .github/PULL_REQUEST_TEMPLATE_PUBLICATION.md

This was causing validation failures because the PR template
is in .github/ root, not in workflows/ subdirectory.
The validation workflow is blocking all PRs. Disabling it
temporarily to unblock the team while we diagnose the root cause.

The workflow file is renamed to .yml.disabled so it won't run.
Change broken links from /merchants/blocks/targeted-block/ to
/merchants/commerce-blocks/personalization/ to fix build errors.
Applied same fixes as b2b-preview (commit e70bec4):
- Complete B2B dropins sidebar with all 4 dropins
- Restored 30 B2B commerce block files
- Added B2B Commerce blocks section to sidebar
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please explain this change

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I removed this. It was a leftover from a generated file.

Copy link
Copy Markdown
Contributor

@keharper keharper left a comment

Choose a reason for hiding this comment

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

The blocks topics should be in a separate PR, as they encompass all B2B functionality. I didn't spend much time on them, as the screenshots haven't been added yet, and that's the bulk of information the topics would contain.

You've added multiple screenshots in this PR, but no topics actually link to them.

Comment thread src/content/docs/dropins-b2b/requisition-list/index.mdx Outdated
Comment thread src/content/docs/dropins-b2b/requisition-list/index.mdx Outdated
Comment thread src/content/docs/dropins-b2b/requisition-list/functions.mdx Outdated
Comment thread src/content/docs/dropins-b2b/requisition-list/functions.mdx Outdated
Comment thread src/content/docs/dropins-b2b/requisition-list/functions.mdx Outdated
Comment thread src/content/docs/dropins-b2b/requisition-list/containers/index.mdx
Comment thread src/content/docs/merchants/blocks/commerce-b2b-quote-checkout.mdx Outdated
keharper and others added 16 commits January 8, 2026 17:26
Fixes:
- Add full documentation for requisitionList/redirect event
- Remove empty Event payload section from requisitionList/initialized
- Move tip about requisitionList/alert into event description
- Move note about requisitionList/redirect into event description
- Add Event flow examples with mermaid sequence diagrams
Fixes:
- Add requisitionList/redirect event documentation (was missing)
- Format alert tip as <Aside type="tip"> within event description
- Format redirect note as <Aside type="note"> within event description
- Remove empty Event payload section from requisitionList/initialized
- Add Event flow examples with practical code showing event sequences
- Replace mermaid diagrams with code examples (mermaid not supported)
@bdenham bdenham requested review from dshevtsov and keharper January 10, 2026 19:37
bdenham added a commit that referenced this pull request Jan 11, 2026
- Add Requisition List dropin documentation
- Add containers, functions, events documentation
Copy link
Copy Markdown
Contributor

@svera svera left a comment

Choose a reason for hiding this comment

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

Good job @bdenham ! some comments from my side

@@ -0,0 +1,95 @@
{
"RequisitionListForm": {
"description": "Provides a form for creating or editing requisition list details including name and description.",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actually, the only details a user can provide are requisition list name and description, so maybe we can just say:

Suggested change
"description": "Provides a form for creating or editing requisition list details including name and description.",
"description": "Provides a form for creating or editing requisition list name and description.",


| Container | Description |
| --------- | ----------- |
| [RequisitionListForm](/dropins-b2b/requisition-list/containers/requisition-list-form/) | Provides a form for creating or editing requisition list details including name and description. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same comment as in _dropin-enrichments/requisition-list/containers.json


| Parameter | Type | Req? | Description |
|---|---|---|---|
| `canCreate` | `boolean` | No | Controls whether users can create new requisition lists from the selector dropdown. Set to false to restrict users to only adding products to existing lists, useful when list creation should happen through a separate flow or requires additional permissions. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This being a not required parameter it is worth nothing that its default value is true


**Package:** `@dropins/storefront-requisition-list`

**Version:** 1.0.0-beta4 (verify compatibility with your Commerce instance)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This refers to beta4, but latest version is beta7



<div style="background-color: var(--sl-color-blue-low); border-left: 4px solid var(--sl-color-blue); padding: 0.75rem 1rem; border-radius: 0.25rem; margin: 1rem 0;">
<strong>Version: 1.0.0-beta4</strong>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This refers to beta4, but latest version is beta7

The Requisition List drop-in exposes slots for customizing specific UI sections. Use slots to replace or extend container components. For default properties available to all slots, see [Extending drop-in components](/dropins/all/extending/).

<div style="background-color: var(--sl-color-blue-low); border-left: 4px solid var(--sl-color-blue); padding: 0.75rem 1rem; border-radius: 0.25rem; margin: 1rem 0;">
<strong>Version: 1.0.0-beta4</strong>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This refers to beta4, but latest version is beta7

Customize the Requisition List drop-in using CSS classes and design tokens. This page covers the Requisition List-specific container classes and customization examples. For comprehensive information about design tokens, responsive breakpoints, and styling best practices, see [Styling Drop-In Components](/dropins/all/styling/).

<div style="background-color: var(--sl-color-blue-low); border-left: 4px solid var(--sl-color-blue); padding: 0.75rem 1rem; border-radius: 0.25rem; margin: 1rem 0;">
<strong>Version: 1.0.0-beta4</strong>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This refers to beta4, but latest version is beta7

@bdenham bdenham requested a review from svera January 13, 2026 16:26
@bdenham bdenham merged commit ba9074b into releases/b2b-nov-release Jan 13, 2026
3 checks passed
@bdenham bdenham deleted the b2b-docs-requisition-list-v3 branch January 13, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-topic A major update published as an entirely new document

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants