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

docs(components): update documentation on components #1583

Merged
merged 1 commit into from
Sep 2, 2024

Conversation

matthieu-crouzet
Copy link
Contributor

Proposed change

Update documentation for components

Copy link

nx-cloud bot commented Apr 3, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 83337c0. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

@github-actions github-actions bot added documentation Improvements or additions to documentation project:@o3r/core labels Apr 3, 2024
@matthieu-crouzet matthieu-crouzet marked this pull request as ready for review April 4, 2024 08:21
@matthieu-crouzet matthieu-crouzet requested a review from a team as a code owner April 4, 2024 08:21
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/localization/LOCALIZATION.md Outdated Show resolved Hide resolved
docs/styling/THEME.md Outdated Show resolved Hide resolved
docs/styling/THEME.md Outdated Show resolved Hide resolved
docs/styling/THEME.md Outdated Show resolved Hide resolved
docs/styling/THEME.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/COMPONENT_REPLACEMENT.md Outdated Show resolved Hide resolved
docs/components/INTRODUCTION.md Outdated Show resolved Hide resolved
sdo-1A
sdo-1A previously approved these changes Apr 4, 2024
docs/configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md Outdated Show resolved Hide resolved
docs/configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md Outdated Show resolved Hide resolved
docs/configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md Outdated Show resolved Hide resolved
docs/configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
docs/configuration/OVERVIEW.md Outdated Show resolved Hide resolved
````

Are not possible through an ``ng-template`` and ``c11n`` combination.

Though there is a solution for the first example in making the value an input, and bind it inside the component using
the [HostBinding](https://angular.io/api/core/HostBinding) decorator, there is no actual solution for applying directive.
A [feature request](https://github.com/angular/angular/issues/8785) has been opened for a long time and finally made it
Copy link
Contributor

Choose a reason for hiding this comment

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

Now that the feature request finally made it, what is the next step ? :D

@matthieu-crouzet matthieu-crouzet force-pushed the docs/components branch 4 times, most recently from dee10a4 to 5975a5c Compare August 28, 2024 08:57
docs/components/INTRODUCTION.md Outdated Show resolved Hide resolved
docs/components/INTRODUCTION.md Outdated Show resolved Hide resolved
@matthieu-crouzet matthieu-crouzet force-pushed the docs/components branch 2 times, most recently from d751810 to 48859f2 Compare August 28, 2024 12:30
@@ -1,22 +1,21 @@
# Component replacement

## Overview

The goal of the feature is to make a component replaceable at runtime.
Copy link
Contributor

Choose a reason for hiding this comment

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

In which context?
Why do we need runtime replacement and can't just build an app as we wish to?

The idea might seem overkill so we should also introduce the reason for this need


* The type of the component to instantiate
* The inputs and outputs to bind
* The potential configuration override to apply

Now let's see how to use that mechanism in practice.
Now let's see how to set this mechanism up to create your replacable components.

## Prepare your base app to register custom components

Copy link
Contributor

Choose a reason for hiding this comment

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

We don't use again the customProviders in this document, should we keep this part?

@@ -1,22 +1,21 @@
# Component replacement
Copy link
Contributor

Choose a reason for hiding this comment

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

There are many mentions of customization app/base app but we never introduce the concepts and we do not provide the script apply custo. We should probably rewrite this example and provide a simple example with a fetch of the replacement map

docs/styling/THEME.md Outdated Show resolved Hide resolved
docs/styling/THEME.md Outdated Show resolved Hide resolved
pginoux-1A
pginoux-1A previously approved these changes Aug 29, 2024
@matthieu-crouzet matthieu-crouzet added this pull request to the merge queue Sep 2, 2024
Merged via the queue into main with commit 4bbf402 Sep 2, 2024
28 checks passed
@matthieu-crouzet matthieu-crouzet deleted the docs/components branch September 2, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants