Skip to content

GAUD-10267: use reactive state properties #7225

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.

Sign up for GitHub

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

Merged
dlockhart merged 2 commits into from
Jul 16, 2026
Merged

GAUD-10267: use reactive state properties #7225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8fe1ea
GAUD-10267: use reactive state properties
dlockhart Jul 15, 2026
d74ccf7
Merge branch 'main' into GAUD-10267/use-reactive-state
dlockhart Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions components/button/floating-buttons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ class FloatingButtons extends LoadingCompleteMixin(LitElement) {
* @type {boolean}
*/
alwaysFloat: { type: Boolean, attribute: 'always-float', reflect: true },
_containerMarginLeft: { attribute: false, type: String },
_containerMarginRight: { attribute: false, type: String },
_containerMarginLeft: { state: true },
_containerMarginRight: { state: true },
_floating: { type: Boolean, reflect: true },
_innerContainerLeft: { attribute: false, type: String }
_innerContainerLeft: { state: true }
};

static styles = css`
Expand Down
2 changes: 1 addition & 1 deletion components/demo/demo-snippet.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class DemoSnippet extends LitElement {
overflowHidden: { type: Boolean, reflect: true, attribute: 'overflow-hidden' },
_code: { type: String },
_fullscreen: { state: true },
_hasSkeleton: { type: Boolean, attribute: false },
_hasSkeleton: { state: true },
_settingsPeek: { state: true },
_skeletonOn: { type: Boolean, reflect: false }
};
Expand Down
2 changes: 1 addition & 1 deletion components/dialog/dialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class Dialog extends PropertyRequiredMixin(LocalizeCoreElement(AsyncContainerMix
* The preferred width (unit-less) for the dialog
*/
width: { type: Number },
_hasFooterContent: { type: Boolean, attribute: false }
_hasFooterContent: { state: true }
};

static styles = [_generateResetStyles(':host'), dialogStyles, heading3Styles, css`
Expand Down
8 changes: 4 additions & 4 deletions components/filter/filter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ class Filter extends FocusMixin(LocalizeCoreElement(LitElement)) {
* @type {string}
*/
text: { type: String },
_activeDimensionKey: { type: String, attribute: false },
_dimensions: { type: Array, attribute: false },
_activeDimensionKey: { state: true },

@dlockhart dlockhart Jul 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hmm, not amazing but I think setting the property will still work:
https://github.com/Brightspace/d2l-manage-courses-ui/blob/6686d7278ab57c904d63e9fd4cf873290a404c0e/test/d2l-source-courses-view.test.js#L106

@dbatiste dbatiste Jul 16, 2026

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.

Yeah. But... grrrr.

_dimensions: { state: true },

@dlockhart dlockhart Jul 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Also not great:

And this one of ours might actually break:

core/components/filter/filter-overflow-group.js

Line 99 in 0aa5797

._dimensions=${newDimensions}

So may need to undo this one.

@dbatiste dbatiste Jul 16, 2026

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.

I don't think changing to state: true will cause breakage here, but maybe I am missing something.

But yeah, seeing consumers calling private members makes me want to double-down on switching all the non-reactive "private" members to use #.

@dlockhart dlockhart Jul 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Agreed 💯. I've confirmed that these still work -- there's actually nothing in Lit that prevents them from being set as properties, which makes sense.

I feel like it's still worthwhile to make the change, even though consumers are referencing these.

_displayKeyboardTooltip: { state: true },
_ignoreSlotChanges: { type: Boolean },
_minWidth: { type: Number, attribute: false },
_totalAppliedCount: { type: Number, attribute: false }
_minWidth: { state: true },
_totalAppliedCount: { state: true }
};

static styles = [bodyCompactStyles, bodySmallStyles, bodyStandardStyles, heading4Styles, offscreenStyles, css`
Expand Down
2 changes: 1 addition & 1 deletion components/form/demo/form-panel-demo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { inputStyles } from '../../inputs/input-styles.js';
class FormPanelDemo extends LitElement {

static properties = {
_expanded: { type: Boolean, attribute: false }
_expanded: { state: true }
};

static styles = [heading3Styles, inputStyles, css`
Expand Down
2 changes: 1 addition & 1 deletion components/form/form-element-mixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export const FormElementMixin = superclass => class extends LocalizeCoreElement(
* @ignore
*/
childErrors: { type: Object, attribute: false },
_errors: { type: Array, attribute: false }
_errors: { state: true }
};

constructor() {
Expand Down
2 changes: 1 addition & 1 deletion components/form/form-error-summary.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class FormErrorSummary extends LocalizeCoreElement(LitElement) {

static properties = {
errors: { type: Object, attribute: false },
_expanded: { type: Boolean, attribute: false },
_expanded: { state: true },
_hasTopMargin: { type: Boolean, attribute: '_has-top-margin', reflect: true },
_hasErrors: { type: Boolean, attribute: '_has-errors', reflect: true },
};
Expand Down
2 changes: 1 addition & 1 deletion components/inputs/input-date-time-range-to.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class InputDateTimeRangeTo extends SkeletonMixin(LocalizeCoreElement(LitElement)
* @type {boolean}
*/
topMargin: { attribute: 'top-margin', type: Boolean },
_blockDisplay: { attribute: false, type: Boolean }
_blockDisplay: { state: true }
};

static styles = [super.styles, bodySmallStyles, css`
Expand Down
2 changes: 1 addition & 1 deletion components/inputs/input-text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ class InputText extends InputInlineHelpMixin(PropertyRequiredMixin(FocusMixin(La
*/
valueAlign: { attribute: 'value-align', type: String },
_firstSlotWidth: { type: Number },
_hasAfterContent: { type: Boolean, attribute: false },
_hasAfterContent: { state: true },
_focused: { type: Boolean },
_hovered: { type: Boolean },
_lastSlotWidth: { type: Number }
Expand Down
2 changes: 1 addition & 1 deletion components/selection/selection-observer-mixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const SelectionObserverMixin = superclass => class extends superclass {
* @type {object}
*/
selectionInfo: { type: Object },
_provider: { type: Object, attribute: false }
_provider: { state: true }
};

constructor() {
Expand Down
2 changes: 1 addition & 1 deletion components/table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ For the example below:
class MySortableTableElem extends LitElement {

static properties = {
_sortDesc: { attribute: false, type: Boolean }
_sortDesc: { state: true }
};

static styles = tableStyles;
Expand Down
10 changes: 5 additions & 5 deletions templates/primary-secondary/primary-secondary.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,11 +596,11 @@ class TemplatePrimarySecondary extends LocalizeCoreElement(LitElement) {
*/
hasForm: { type: Boolean, attribute: 'has-form' },
_formErrorSummary: { type: Array },
_hasFooter: { type: Boolean, attribute: false },
_isCollapsed: { type: Boolean, attribute: false },
_isExpanded: { type: Boolean, attribute: false },
_isMobile: { type: Boolean, attribute: false },
_size: { type: Number, attribute: false },
_hasFooter: { state: true },
_isCollapsed: { state: true },
_isExpanded: { state: true },
_isMobile: { state: true },
_size: { state: true },
_sizeAsPercent: { state: true }
};

Expand Down