Skip to content

Commit

Permalink
chore: docs Subclasser conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
tlouisse committed Mar 2, 2020
1 parent 2e064b4 commit 993d37b
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

First be sure to understand our [definitions](./definitions.md).

- [Guidelines for Styling](./guidelinesStyling.md)
- [Guidelines for Styling](./guidelines-styling.md)
File renamed without changes.
29 changes: 29 additions & 0 deletions docs/subclasser-apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Subclasser apis

In order to make it easy for Subclassers to extend our components, we follow a certain set
of best practices naming conventions to make our code predictable.

## Templates

### Template naming conventions

For template, we have the naming convention that every overridable template starts with an
underscore and ends with

### Seperation of concerns

Our components should make it possible to override markup and styling, without having to redefine
functionality.
By using the spread directive, we can achieve this. For more info, see:
[https://github.com/ing-bank/lion/issues/591](explanation).

## Node references

As a Subclasser, you sometimes need access to a protected node inside the shadow dom.
Most functional nodes have their own getters. A Subclasser can acces those in his extension and
in some cases, override these getters.

### Node naming conventions

A node reference will have an underscore prefix and always ends with `Node`.
Examples are `_inputNode` and `_formNode`.

0 comments on commit 993d37b

Please sign in to comment.