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

fix(ext typings): remove some accessibility modifiers from Component #3437

Merged
merged 2 commits into from
Jun 20, 2022

Conversation

davwheat
Copy link
Member

@davwheat davwheat commented May 20, 2022

Changes proposed in this pull request:

At the moment, our Component class has various protected attributes and methods. Sometimes, we need to override/extend these methods (initAttrs) or to use these attributes (this.$/this.attrs) within the body of extend or override.

This presents an issue, as our typings pretend these don't exist outside of the class and its subclasses, so show up as errors in TS.

image

This PR removes those accessibility modifiers to prevent these TS errors.

Reviewers should focus on:

I don't see this as an issue since these are regularly used outside of the classes anyway in JS-based extends/overrides.

Necessity

  • Has the problem that is being solved here been clearly explained?
  • If applicable, have various options for solving this problem been considered?
  • For core PRs, does this need to be in core, or could it be in an extension?
  • Are we willing to maintain this for years / potentially forever?

Confirmed

  • Frontend changes: tested on a local Flarum installation.
  • Backend changes: tests are green (run composer test).
  • Core developer confirmed locally this works as intended.
  • Tests have been added, or are not appropriate here.

@davwheat davwheat added this to the 1.4 milestone May 20, 2022
@davwheat davwheat self-assigned this May 20, 2022
@davwheat davwheat force-pushed the dw/attribute-accessibility branch from f9a4b1c to e2bc6ec Compare June 2, 2022 02:08
@SychO9 SychO9 modified the milestones: 1.3.1, 1.4 Jun 7, 2022
@davwheat davwheat merged commit 9fc2e5e into main Jun 20, 2022
@davwheat davwheat deleted the dw/attribute-accessibility branch June 20, 2022 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants