Skip to content

What is the complete Polymer Public API? #1233

Description

I've read pretty much all there is at https://www.polymer-project.org/docs/polymer/polymer.html. I've also stepped through and poked through a fair amount of the code base. There are several element and instance methods that are accessible, and do not have a leading nor trailing underscore, implying they're not private. However none of them are in any documentation I can find.

Realizing Polymer is still "pre-release" and anything could change at anytime, is there some convention or other document that might clarify which, if any, other accessible methods and functions are considered part of the public API and are safe to use?

Activity

  1. masonlouchart commented on Mar 2, 2015

    @masonlouchart

    I recommend to use the version 0.5.5 or even 0.5.4 for now. But there will huge changes with the next release 0.8.
    https://divshot.com/blog/web-components/polymer-0-8-sneak-peek/

  2. robdodson commented on Mar 2, 2015

    @robdodson
    Contributor

    We've talked about the need for an API Reference for a while. At the moment it's on the list of things we want but doesn't have an ETA. cc @nevir and @arthurevans

  3. nevir commented on Mar 2, 2015

    @nevir
    Contributor

    I think it's unlikely that we'll have an API reference in time for 0.8; probably closer to 0.9 timeframe.

    As for 0.5 goes, we're not as consistent as we'd like with underscore prefixed properties. I would assume private unless documented or stated elsewhere (not great, I know). In 0.8 we're doing a lot better marking things as actually private, so it should hopefully be more clear even before the docs land

  4. ghost closed this as completedon Mar 2, 2015
  5. robdodson commented on Mar 2, 2015

    @robdodson
    Contributor

    @phestermcs there's been discussion about this but I'm not sure if there are any immediate plans to address it. @dglazkov may know more

  6. dglazkov commented on Mar 2, 2015

    @dglazkov

    Namespacing is tracked by https://www.w3.org/Bugs/Public/show_bug.cgi?id=24578 spec bug.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions