Polymer/old-docs-site

Properties outside the properties object

Open

#2463 opened on Feb 6, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (1,013 stars) (2,482 forks)batch import
P3docsgood first issuequestion

Description

From @hadriann on February 5, 2018 17:31

Description

The usage of properties outside of the properties object is not documented. From the docs:

In most cases, a property that's part of your element's public API should be declared in the properties object.

It is implied that there are use cases when you need not declare a property in the properties object.

One such use case might be a component's private property (like a config), that is set by the component itself (not received via attributes), and passed down to one of its children.

There are a few questions regarding this:

  1. Is the above scenario (or any scenario) a valid use case for outside-the-properties properties?
  2. Will basic data binding work for such properties?
  3. Will computed data binding work?
  4. Will such a property be bound at the first render (ready) of the markup?
  5. What is the best practice (Polymer-way) to declare or use such private properties?

Copied from original issue: Polymer/polymer#5093

Contributor guide

Tech stack
javascriptweb components
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Polymerweb components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the Polymer documentation and source code to answer the five questions about properties declared outside the properties object. Since the repository 'old docs site' is deprecated and replaced by polymer project.org and polymer library docs, consider whether the issue should be migrated or closed. Provide a clear explanation with best practices for private properties in Polymer elements.